v5

OpenAPI 3.1.02026-08-037720751.3 KB

Tasks

List tasks

List all tasks. Results are sorted by creation date, from oldest to newest.

Required scopes: task:read, object_configuration:read, record_permission:read, user_management:read.

get/v2/tasks

Query parameters

limitinteger

The maximum number of results to return. Defaults to 500. See the full guide to pagination here.

Example:10

offsetinteger

The number of results to skip over before returning. Defaults to 0. See the full guide to pagination here.

Example:5

sort'created_at:asc' | 'created_at:desc' | 'completed_at:asc' | 'completed_at:desc'

Optionally sort the results. "created_at:asc" returns oldest results first, "created_at:desc" returns the newest results first. "completed_at:asc" and "completed_at:desc" sort by completion time. With "completed_at:asc", incomplete tasks (no completion date) appear first, followed by completed tasks oldest-first. With "completed_at:desc", completed tasks appear first (newest-first), followed by incomplete tasks. To exclude incomplete tasks, filter by is_completed. If unspecified, defaults to "created_at:asc" (oldest results first).

Example:created_at:desc

linked_objectstring

Pass a value to this parameter to filter results to only those tasks that contain the specified record in the linked_records property of the task. This parameter should identify the object that the linked record belongs to. For example, if filtering to tasks that link to a specific person record, this parameter should be people. If provided, linked_record_id must also be provided.

Example:people

linked_record_idstring uuid

Pass a value to this parameter to filter results to only those tasks that contain the specified record in the linked_records property of the task. This parameter should contain the record ID of the linked record. If provided, linked_object must also be provided.

Example:891dcbfc-9141-415d-9b2a-2238a6cc012d

assigneestring nullable

Filter tasks by workspace member assignees. Workspace members can be referenced by either their email address or ID. Pass an empty value or the string null to find tasks with no assignee.

Example:50cf242c-7fa3-4cad-87d0-75b1af71c57b

is_completedboolean

Filter tasks by whether they have been completed. By default, both completed and non-completed tasks are returned. Specify true to only return completed tasks, or false to only return non-completed tasks.

Example:true

Response

Success

Example response

{
  "data": [
    {
      "id": {
        "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
        "task_id": "649e34f4-c39a-4f4d-99ef-48a36bef8f04"
      },
      "content_plaintext": "Follow up on current software solutions",
      "deadline_at": "2023-01-01",
      "completed_at": "2022-11-21T13:22:49.061281000Z",
      "linked_records": [
        {
          "target_object_id": "people",
          "target_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d"
        }
      ],
      "assignees": [
        {
          "referenced_actor_type": "workspace-member",
          "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
        }
      ],
      "created_by_actor": {
        "type": "workspace-member",
        "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
      },
      "created_at": "2022-11-21T13:22:49.061281000Z"
    }
  ]
}