v1

latestOpenAPI 3.1.12026-07-124448163.2 KB

tasks

List tasks

Returns a paginated list of tasks with optional client and workspace filters.

get/tasks

Query parameters

limitnumber

The number of items to return

Example:20

cursorstring cuid

The cursor to return the next page of items

Example:cmf41ajzv003706un4i99q19z

workspaceIdstring cuid

The ID of the workspace

Example:cmf41ajzv003706un4i99q19z

parentIdstring cuid

The ID of the parent task

Example:cmf41ajzv003706un4i99q19z

sort'createdAt' | 'updatedAt' | 'dueDate' | 'status' | 'title'

The sort field of the results

Example:createdAt

order'asc' | 'desc'

The order of the results based on the sort field

Example:desc

Headers

x-client-idstring cuid required

The ID of the client

Example:cmf41ajzv003706un4i99q19z

Response

Tasks

Example response

{
  "data": [
    {
      "id": "cmf41ajzv003706un4i99q19z",
      "title": "Task 1",
      "text": "Upload the documents",
      "status": "OPEN",
      "dueDate": "2021-01-01T00:00:00Z",
      "workspaceId": "cmf41ajzv003706un4i99q19z",
      "createdById": "cmf41ajzv003706un4i99q19z",
      "actorType": "USER",
      "parentId": "cmf41ajzv003706un4i99q19z",
      "destinationFolderId": "cmf41ajzv003706un4i99q19z",
      "createdAt": "2021-01-01T00:00:00Z",
      "updatedAt": "2021-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "nextCursor": "cmf41ajzv003706un4i99q19z",
    "previousCursor": "cmf41ajzv003706un4i99q19z",
    "limit": 20,
    "total": 134
  }
}