v1

latestOpenAPI 3.1.02026-07-261630686.8 KB

Lista de tareas

get/api/v4/tasks

Query parameters

pageinteger

Número de página

limitinteger

El número de entidades retornadas en la respuesta de una solicitud (límite: 250)

filter[responsible_user_id][]integer[]

El número de entidades retornadas en la respuesta de una solicitud (límite: 250)

filter[is_completed]integer

Filtrar por el estado de la tarea. 1 – completada, 0 – abierta

filter[task_type][]integer[]

Filtrar por el ID del tipo de tarea. Se puede pasar un único ID o un arreglo de IDs

filter[entity_type]'leads' | 'contacts' | 'companies'

Filtrar por el tipo de entidad a la que está vinculada la tarea

filter[entity_id][]integer[]

Filtrar por el ID de la entidad a la que está vinculada la tarea. Para utilizar el filtro, el valor debe pasarse en filter[entity_type]. Se puede pasar un solo ID o un arreglo de IDs

filter[id][]integer[]

Filtrar por el ID de la tarea. Se puede pasar un solo ID o un arreglo de IDs

filter[updated_at]integer

Filtrar por la última edición de la tarea. Se puede pasar una marca de tiempo, en ese caso, se retornarán las tareas editadas después del valor de la marca de tiempo

filter[updated_at][from]integer

Filtrar por la última edición de la tarea. Se puede pasar una marca de tiempo

filter[updated_at][to]integer

Filtrar por la última edición de la tarea. Se puede pasar un valor de marca de tiempo

order[complete_till]string

Valores disponibles para ordenar: asc, desc

order[created_at]string

Valores disponibles para ordenar: asc, desc

order[id]string

Valores disponibles para ordenar: asc, desc

Response

200

_pageinteger

Example response

{
  "_page": 1,
  "_links": {
    "self": {
      "href": "https://example.kommo.com/api/v4/tasks?filter[task_type]=2&filter[is_completed]=1&limit=2&page=1"
    },
    "next": {
      "href": "https://example.kommo.com/api/v4/tasks?filter[task_type]=2&filter[is_completed]=1&limit=2&page=2"
    }
  },
  "_embedded": {
    "tasks": [
      {
        "id": 7087,
        "created_by": 3987910,
        "updated_by": 3987910,
        "created_at": 1575364000,
        "updated_at": 1575364851,
        "responsible_user_id": 123123,
        "entity_id": 167353,
        "entity_type": "leads",
        "is_completed": true,
        "task_type_id": 2,
        "text": "Enviar una invitación",
        "complete_till": 1575665940,
        "account_id": 321321,
        "_links": {
          "self": {
            "href": "https://example.kommo.com/api/v4/tasks/7087"
          }
        }
      }
    ]
  }
}