Tasks

Manage follow-up tasks

Retrieves tasks

get/tasks

Returns a paginated list of tasks. Filter by assignee, contact, or status.

Tasks represent follow-up actions for contacts (calls, meetings, etc.).

Parámetros de consulta

  • pageinteger
    Page number for pagination
    Por defecto: 1Ejemplo: 1
  • limitinteger
    Number of records per page
    Por defecto: 25Ejemplo: 25
  • order_bystring
    Field to order results by
    Valores:created_atupdated_atcompleted_atstarted_atactive_onidentifierinternal_identifieridentifier_prioritypriorityattemptsstatussubject_typeskillscreated_outside_working_hourshas_skillspredictive_callprogressive_calltransferable_idaccount_idassignee_idcontact_idsubject_idplaybook_idtask_team_idtask_template_idPor defecto: created_at
  • sortstring
    Sort direction (asc or desc)
    Valores:ascdescPor defecto: desc

Respuestas

  • 200tasks found
  • 400field is not sortable
  • 401unauthorized
Petición
curl -X GET 'https://api.vixiees.com/api/v1/tasks' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 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/tasks

Creates 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.

Cuerpo de la petición · application/json

  • task_subject_idstringobligatorio
    Ejemplo: 64a1b2c3d4e5f678901234ab
  • task_subject_typestringobligatorio
    Ejemplo: Contact
  • task_template_idstringobligatorio
    Ejemplo: 64a1b2c3d4e5f678901235fe
  • commentstring
    Ejemplo: Some comment
  • active_onstring (date-time)
    Ejemplo: 2024-12-31T23:59:59Z
  • assignee_idstring
    Ejemplo: 64a1b2c3d4e5f678901235fe

Respuestas

  • 200task created
  • 401unauthorized
  • 422unprocessable entity
Petición
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"
}'
Respuesta de ejemplo · 200
{
  "id": "string"
}

Cancels a task

post/tasks/{id}/cancel

Marks a task as cancelled. The task will no longer appear in the task queue.

Parámetros de ruta

  • idstringobligatorio
    The ID of the task to cancel
    Ejemplo: 64a1b2c3d4e5f678901234ab

Respuestas

  • 200task cancelled
  • 401unauthorized
  • 404task not found
Petición
curl -X POST 'https://api.vixiees.com/api/v1/tasks/64a1b2c3d4e5f678901234ab/cancel' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "status": "ok"
}

Completes a task

post/tasks/{id}/complete

Marks a task as completed. Records the completion time and removes it from the task queue.

Parámetros de ruta

  • idstringobligatorio
    The ID of the task to complete
    Ejemplo: 64a1b2c3d4e5f678901234ab

Respuestas

  • 200task completed
  • 401unauthorized
  • 404task not found
Petición
curl -X POST 'https://api.vixiees.com/api/v1/tasks/64a1b2c3d4e5f678901234ab/complete' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "status": "ok"
}