v3

OpenAPI 3.1.02026-07-2759128137.8 KB
tasks

List Tasks

List tasks in the workspace.

Requires the tasks:read scope on the API key.

get/v1/tasks

Query parameters

pageinteger

Page number.

Page number.

sizeinteger

Number of items per page.

Number of items per page.

sort_by'created_at' | 'updated_at'

Field to sort by.

sort_order'asc' | 'desc'

Sort direction.

sequence_idstring uuid nullable

Filter by an individual sequence run.

Filter by an individual sequence run.

sequence_template_idsstring[] nullable

Filter by sequence template. Repeat the parameter to pass multiple values.

Filter by sequence template. Repeat the parameter to pass multiple values.

typesTaskType[] nullable

Filter by task type. Repeat the parameter to pass multiple values.

Filter by task type. Repeat the parameter to pass multiple values.

status'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'SKIPPED'

Filter by status.

prioritiesTaskPriority[] nullable

Filter by priority bucket. Repeat the parameter to pass multiple values.

Filter by priority bucket. Repeat the parameter to pass multiple values.

assignee_user_idstring uuid nullable

Filter by assignee.

Filter by assignee.

created_at_afterstring date-time nullable

Return tasks created strictly after this timestamp.

Return tasks created strictly after this timestamp.

created_at_beforestring date-time nullable

Return tasks created strictly before this timestamp.

Return tasks created strictly before this timestamp.

Response

Successful Response

total_countinteger required

Total number of records matching the query.

total_pagesinteger required

Total number of pages.

has_moreboolean required

Whether more pages remain after the current one.