v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Sequences

List all sequences

<small>Requires the sequences:read scope (or a broader one that includes it).</small>

Returns a paginated list of all sequences in your account. Results are ordered by creation date, newest first, unless overridden with sortBy / sortDirection.

get/v3/sequences

Query parameters

topinteger

Maximum number of items to return (default 25, max 1000)

skipinteger

Number of items to skip

status'active' | 'paused' | 'new'

Filter sequences by status

ownerUserIdinteger

Filter sequences by owner user ID

folderIdstring uuid

Filter sequences by folder ID

isArchivedboolean

Filter sequences by archive status. When true, returns only archived sequences. When false, returns only non-archived sequences. When omitted, returns all sequences regardless of archive status.

namestring

Search sequences by name (case-insensitive, partial match)

createdAfterstring date-time

Return only sequences created after this timestamp (ISO-8601).

sortBy'created' | 'name' | 'status'

Field to sort results by. When omitted, results are ordered by creation date.

sortDirection'asc' | 'desc'

Sort direction. Requires sortBy to be set; supplying sortDirection alone is rejected with 400. When omitted, created sorts descending (newest first) while name and status sort ascending.

Response

List of sequences retrieved successfully

hasMoreboolean

Indicates if there are more items to fetch

Example response

{
  "items": [
    {
      "id": 12345,
      "ownerUserId": 42,
      "name": "Sales Outreach",
      "status": "active",
      "created": "2024-03-08T10:00:00+00:00",
      "isArchived": false,
      "health": "healthy"
    },
    {
      "id": 12346,
      "ownerUserId": 42,
      "name": "Follow-up Campaign",
      "status": "paused",
      "created": "2024-03-07T14:30:00+00:00",
      "isArchived": false,
      "health": "degraded"
    }
  ],
  "hasMore": true
}