Sign in

v2

latestOpenAPI 3.0.02026-07-26365590.3 KB
Sequences

List sequences

Returns a paginated list of sequences scoped to the workspaces accessible by the API key. Use the workspaceIds query parameter to narrow results to a subset of those workspaces.

get/v1/sequences

Query parameters

workspaceIdsstring
Example:550e8400-e29b-41d4-a716-446655440000,6ba7b810-9dad-11d1-80b4-00c04fd430c8

Workspace IDs to narrow down results. Must be a subset of the workspaces accessible by the API key. Omit to return data from every workspace in scope. Accepts either a comma-separated string (?workspaceIds=uuid1,uuid2) — the documented format — or repeated array params (?workspaceIds[]=uuid1&workspaceIds[]=uuid2).

pagenumber
Example:1

Page number (1-indexed)

limitnumber
Example:50

Number of items per page

Response

Paginated list of sequences

totalnumber required
pagenumber required
limitnumber required
totalPagesnumber required

Example response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "My Sales Sequence",
      "organizationMembershipId": "123e4567-e89b-12d3-a456-426614174001",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "contactCount": 150,
      "assignedTo": [
        {
          "organizationMembershipId": "123e4567-e89b-12d3-a456-426614174000",
          "email": "john.doe@example.com"
        }
      ]
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}