tasks

List Tasks

Changed on

List tasks in the workspace.

Requires the tasks:read scope on the API key.

get/v1/tasks

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/tasks
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number.

sizeinteger

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.

sequence_template_idsstring[] nullable

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

typesTaskType[] nullable

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.

assignee_user_idstring uuid nullable

Filter by assignee.

contact_idstring uuid nullable

Filter by contact linked to the task or its sequence.

created_at_afterstring date-time nullable

Return tasks created strictly after this timestamp.

created_at_beforestring date-time nullable

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.

Changes

  • 80f4fd40b75eRevision changes
    • info

      added the optional property // to the response with the status

  • 2f1c56db78f8Revision changes
    • warning

      added the new WRONG_NUMBER enum value to the /// response property for the response status