Sign in
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.

contact_idstring uuid nullable

Filter by contact linked to the task or its sequence.

Filter by contact linked to the task or its sequence.

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.

Changes

Changed in 6 of the 12 revisions of this API.48

  • 80f4fd40b75e1See the full diff
    • ○

      added the optional property items/items/snoozed_until to the response with the 200 status

      response-optional-property-added

  • 2f1c56db78f81See the full diff
    • ●

      added the new WRONG_NUMBER enum value to the items/items/disposition/anyOf[subschema #1: CallDisposition]/ response property for the response status 200

      response-property-enum-value-added

  • 2bd7bb8e3a372See the full diff
    • ●

      added the new INTERESTED enum value to the items/items/disposition/anyOf[subschema #1: CallDisposition]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new NOT_INTERESTED enum value to the items/items/disposition/anyOf[subschema #1: CallDisposition]/ response property for the response status 200

      response-property-enum-value-added

  • b390cd1c4e2a1See the full diff
    • ○

      added the new optional query request parameter contact_id

      new-optional-request-parameter

  • 467ce2bf692b5See the full diff
    • ○

      added the optional property items/items/assignee to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/contact to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/due_date to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/sequence_template to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/title to the response with the 200 status

      response-optional-property-added

  • 89675e210f3411See the full diff
    • ●

      added the new TODO enum value to the items/items/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value TODO to the property anyOf[subschema #1]/items/ of the query request parameter types

      request-parameter-property-enum-value-added