v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Tasks list

get/api/v4/tasks

Query parameters

pageinteger

Page number

limitinteger

The number of the entities returned in the response of one request (limit – 250)

filter[responsible_user_id][]integer[]

Filter by the task responsible user ID. Either a single ID or an array of IDs can be passed

filter[is_completed]integer

Filter by the task status. 1 – completed, 0 – open

filter[task_type][]integer[]

Filter by the task type ID. Either a single ID or an array of IDs can be passed

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

Filter by the entity type the task is linked to

filter[entity_id][]integer[]

Filter by the entity ID the task is linked to. To use the filter, the value should be passed into filter[entity_type]. Either a single ID or an array of IDs can be passed

filter[id][]integer[]

Filter by the task ID. Either a single ID or an array of IDs can be passed

filter[updated_at]integer

Filter by the last task edit. A timestamp can be passed, in that case, tasks edited after the timestamp value will be returned.

filter[updated_at][from]integer

Filter by the last task edit. A timestamp can be passed.

filter[updated_at][to]integer

Filter by the last task edit. A timestamp can be passed.

order[complete_till]string

Values available to sort by: asc, desc.

order[created_at]string

Values available to sort by: asc, desc.

order[id]string

Values available to sort by: 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": "Send an invitation",
        "complete_till": 1575665940,
        "account_id": 321321,
        "_links": {
          "self": {
            "href": "https://example.kommo.com/api/v4/tasks/7087"
          }
        }
      }
    ]
  }
}