Tasks
Manage follow-up tasks
Retrieves tasks
get
/tasksReturns a paginated list of tasks. Filter by assignee, contact, or status.
Tasks represent follow-up actions for contacts (calls, meetings, etc.).
Query parameters
- Page number for pagination
pageintegerDefault:1Example:1 - Number of records per page
limitintegerDefault:25Example:25 - Field to order results by
order_bystringValues:created_atupdated_atcompleted_atstarted_atactive_onidentifierinternal_identifieridentifier_prioritypriorityattemptsstatussubject_typeskillscreated_outside_working_hourshas_skillspredictive_callprogressive_calltransferable_idaccount_idassignee_idcontact_idsubject_idplaybook_idtask_team_idtask_template_idDefault:created_at - Sort direction (asc or desc)
sortstringValues:ascdescDefault:desc
Responses
200tasks found400field is not sortable401unauthorized
Request
curl -X GET 'https://api.vixiees.com/api/v1/tasks' \
-H 'X-Api-Key: YOUR_API_KEY'Example response 路 200
{
"results": [
{
"_id": "string",
"identifier": "string",
"status": "string",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
],
"page_info": {
"current_page": 0,
"limit": 0
}
}Creates a new task
post
/tasksCreates a new task for contact follow-up.
Tasks are based on task templates which define the type of follow-up action.
Optionally schedule the task for a specific date using active_on.
Request body 路 application/json
task_subject_idstringrequiredExample:64a1b2c3d4e5f678901234abtask_subject_typestringrequiredExample:Contacttask_template_idstringrequiredExample:64a1b2c3d4e5f678901235fecommentstringExample:Some commentactive_onstring (date-time)Example:2024-12-31T23:59:59Zassignee_idstringExample:64a1b2c3d4e5f678901235fe
Responses
200task created401unauthorized422unprocessable entity
Request
curl -X POST 'https://api.vixiees.com/api/v1/tasks' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"task_subject_id": "64a1b2c3d4e5f678901234ab",
"task_subject_type": "Contact",
"task_template_id": "64a1b2c3d4e5f678901235fe",
"comment": "Some comment",
"active_on": "2024-12-31T23:59:59Z",
"assignee_id": "64a1b2c3d4e5f678901235fe"
}'Example response 路 200
{
"id": "string"
}Cancels a task
post
/tasks/{id}/cancelMarks a task as cancelled. The task will no longer appear in the task queue.
Path parameters
- The ID of the task to cancel
idstringrequiredExample:64a1b2c3d4e5f678901234ab
Responses
200task cancelled401unauthorized404task not found
Request
curl -X POST 'https://api.vixiees.com/api/v1/tasks/64a1b2c3d4e5f678901234ab/cancel' \
-H 'X-Api-Key: YOUR_API_KEY'Example response 路 200
{
"status": "ok"
}Completes a task
post
/tasks/{id}/completeMarks a task as completed. Records the completion time and removes it from the task queue.
Path parameters
- The ID of the task to complete
idstringrequiredExample:64a1b2c3d4e5f678901234ab
Responses
200task completed401unauthorized404task not found
Request
curl -X POST 'https://api.vixiees.com/api/v1/tasks/64a1b2c3d4e5f678901234ab/complete' \
-H 'X-Api-Key: YOUR_API_KEY'Example response 路 200
{
"status": "ok"
}