sequences

List Sequences

Changed on

List sequence runs in the workspace.

Requires the sequences:read scope on the API key.

get/v1/sequences

Request

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

Query parameters

pageinteger

Page number.

sizeinteger

Number of items per page.

sort_by'created_at' | 'updated_at' | 'status'

Field to sort by.

sort_order'asc' | 'desc'

Sort direction.

sequence_template_idstring uuid nullable

Filter by template.

contact_idstring uuid nullable

Filter by the contact the sequence targets.

status'ACTIVE' | 'SUCCEEDED' | 'FAILED' | 'COMPLETED' | 'WAITING_FOR_LEAD' | 'WAITING_FOR_USER' | 'STOPPED_EARLY' | 'FOUND' | 'REFUSED'

Filter by status.

created_at_beforestring date-time nullable

Return sequences created strictly before this timestamp.

created_at_afterstring date-time nullable

Return sequences created strictly after 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

  • b390cd1c4e2aRevision changes
    • info

      added the new optional query request parameter contact_id

  • 467ce2bf692bRevision changes
    • info

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

    • info

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