List Tasks

List tasks, most recently updated first. Archived tasks are excluded unless include_archived=true.

Paginate with next_cursor. Sort with updated, created, deadline, priority, or manual (board order).

GET /api/v1/tasks

List Tasks

cURL

curl --request GET \
  --url https://{tenant_id}.api.useago.com/api/v1/tasks \
  --header 'X-API-Key: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "status": {
        "key": "<string>",
        "label": "<string>",
        "category": "<string>",
        "role": "<string>"
      },
      "priority": "<string>",
      "labels": [
        {
          "id": "<string>",
          "name": "<string>",
          "color": "<string>"
        }
      ],
      "links": [
        {
          "id": "<string>",
          "target_type": "<string>",
          "target_id": "<string>",
          "context": {
            "conversation_id": "<string>",
            "message_id": "<string>"
          },
          "deleted": true,
          "admin_url": "<string>"
        }
      ],
      "source": "<string>",
      "revision": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "admin_url": "<string>",
      "identifier": "<string>",
      "description": "",
      "deadline": "2023-12-25",
      "owner": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      },
      "created_by": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      },
      "finished_at": "2023-11-07T05:31:56Z",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "object": "list",
  "next_cursor": "<string>",
  "total": 123
}

Authorizations

X-API-Key · string · header · required

Query Parameters

queue · string | null

mine, review, unowned, or all

owner · string | null

me, none, or a user id (comma-separate several)

status · string | null

Status keys, comma-separated

category · string | null

todo, in_progress, done, canceled (comma-separated)

label_id · string | null

Label ids or none, comma-separated

priority · string | null

source · string | null

due_before · string<date> | null

due_after · string<date> | null

overdue · boolean | null

q · string | null

Case-insensitive match on the title, or a task identifier such as TASK-12

include_archived · boolean · default: false

archived_only · boolean · default: false

show_all · boolean · default: false

conversation_id · string<uuid> | null

ticket_id · string<uuid> | null

feedback_id · string<uuid> | null

message_id · string<uuid> | null

knowledge_update_request_id · string<uuid> | null

sort · string · default: updated

cursor · string | null

limit · integer · default: 50

Response

200 - application/json

OK

data · TaskOut · object[] · required

Show child attributes

has_more · boolean · required

object · string · default: list

next_cursor · string | null

Pass as cursor to fetch the next page.

total · integer | null

Matching tasks; only on the first page.