v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

Tasks

Get all tasks

get/crm/tasks

Query parameters

filter[type]string

Filter by task type (ID)

filter[status]'done' | 'undone'

Filter by task status

filter[date]'overdue' | 'today' | 'tomorrow' | 'week' | 'range'

Filter by date

filter[assignTo]string

Filter by the "assignTo" ID. You can utilize account emails for the "assignTo" attribute.

filter[contacts]string

Filter by contact ids

filter[deals]string

Filter by deals ids

filter[companies]string

Filter by companies ids

dateFrominteger

dateFrom to date range filter type (timestamp in milliseconds)

dateTointeger

dateTo to date range filter type (timestamp in milliseconds)

offsetinteger

Index of the first document of the page

limitinteger

Number of documents per page

sort'asc' | 'desc'

Sort the results in the ascending/descending order. Default order is descending by creation if sort is not passed

sortBystring

The field used to sort field names.

Response

Returns task list with filters

Example response

{
  "items": [
    {
      "taskTypeId": "61a5cd07ca1347c82306ad09",
      "name": "Task: Connect with client",
      "contactsIds": [
        1,
        2,
        3
      ],
      "dealsIds": [
        "61a5ce58c5d4795761045990",
        "61a5ce58c5d4795761045991",
        "61a5ce58c5d4795761045992"
      ],
      "id": "61a5cd07ca1347c82306ad06",
      "companiesIds": [
        "61a5ce58c5d4795761045990",
        "61a5ce58c5d4795761045991",
        "61a5ce58c5d4795761045992"
      ]
    },
    {
      "taskTypeId": "61a5cd07ca1347c82306ad09",
      "name": "Task: Connect with client",
      "contactsIds": [
        1,
        2,
        3
      ],
      "dealsIds": [
        "61a5ce58c5d4795761045990",
        "61a5ce58c5d4795761045991",
        "61a5ce58c5d4795761045992"
      ],
      "id": "61a5cd07ca1347c82306ad06",
      "companiesIds": [
        "61a5ce58c5d4795761045990",
        "61a5ce58c5d4795761045991",
        "61a5ce58c5d4795761045992"
      ]
    }
  ]
}