Sign in

v2

latestOpenAPI 3.0.02026-07-26365590.3 KB
Sequences

List contacts of a sequence

Returns a paginated list of contacts in a sequence, enriched with their tags and call history within the sequence. Supports filtering by tag label and contact status. Returns 404 if the parent sequence is in a workspace outside the API key scope.

get/v1/sequences/{id}/contacts

Path parameters

idstring required

Query parameters

pagenumber
Example:1

Page number (1-indexed)

limitnumber
Example:50

Number of items per page

tagstring
Example:hot-lead

Filter contacts by tag label

status'CONNECTED' | 'RESPONDER' | 'ERROR' | 'CANCELLED' | 'RUNNING' | 'MISSING_NUMBER'
Example:CONNECTED

Filter contacts by call status

Response

Paginated list of sequence contacts with tags and calls

totalnumber required
pagenumber required
limitnumber required
totalPagesnumber required

Example response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "CONNECTED",
      "contact": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "John",
        "lastName": "Doe",
        "phoneNumbers": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "number": "+33612345678"
          }
        ]
      },
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "label": "hot-lead",
          "isSuccessTag": true
        }
      ],
      "calls": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "status": "COMPLETED",
          "createdAt": "2024-01-15T10:30:00.000Z"
        }
      ],
      "createdAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}