List tasks

GET/v1/drive/tasks

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Query Parameters

listId*string

Required. The list to read tasks from.

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

statusCategory?string

Workflow category the status belongs to.

includeArchived?string

Pass true to include archived tasks.

limit?integer

Default100

Range1 <= value <= 200

offset?integer

Default0

Range0 <= value <= 100000

Response Body

`application/json`

cURL

curl -X GET "https://example.com/drive/tasks?listId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "tasks": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "identifier": "string",
      "title": "string",
      "description": "string",
      "listId": "9fc6ad7d-902a-4834-b161-a4911b883d44",
      "spaceId": "a330a273-e64a-4183-aedb-f3152797a9a5",
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
      "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
      "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
      "statusCategory": "backlog",
      "priority": -9007199254740991,
      "taskType": "string",
      "startDate": "string",
      "dueDate": "string",
      "completedAt": "2019-08-24T14:15:22Z",
      "points": 0,
      "timeEstimateSeconds": -9007199254740991,
      "isDraft": true,
      "archived": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "limit": -9007199254740991,
    "offset": -9007199254740991,
    "total": 0,
    "hasMore": true
  }
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "unauthorized"
}

{
  "success": false,
  "error": "API key lacks write permission"
}

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

`application/json`

`application/json`

`application/json`

`application/json`