Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Tasks

Get all tasks

Get information as a list of all tasks.

get/tasks

Query parameters

countinteger

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

task_type_idstring
Example:8bed991c68a470e7aaeffbf048

Task type ID from the resource GET /task-types. The parameter filters tasks by their type.

task_state_idstring
Example:86e05affc7a7abefcd513ab400

Task state ID from the resource GET /task-states. The parameter filters tasks by their state.

customer_idstring

The unique ID of the customer. GET /customers

priority1 | 2 | 3 | 4

The parameter filters tasks by their priority. Possible values are: 1 - Critical / 2 - Major / 3 - Normal / 4 - Minor.

due_datestring

Due date of the task in ISO-8601 format (YYYY-MM-DD).

task_titlestring

Search record by the task summary or a part of the task summary.

task_notestring

Search record by the task note or a part of the task note.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

OK

Example response

{
  "data": {
    "tasks": [
      {
        "task_id": "8bed991c68a470e7aaeffbf048",
        "task_type_id": "8bed991c68a470e7aaeffbf048",
        "task_state_id": "8bed991c68a470e7aaeffbf048",
        "customer_id": "85aae99524edceec17682e01b9",
        "task_note": "Could you please send me last invoice to my email?",
        "task_title": "Customer invoice",
        "task_priority": 3,
        "due_date": "2023-04-01",
        "created_at": "2023-03-28 16:59:49",
        "state": 1
      }
    ],
    "total_items": 1
  }
}