Skip to main content
GET
/
v1
/
sequences
/
{id}
/
contacts
List contacts of a sequence
curl --request GET \
  --url https://api.example.com/v1/sequences/{id}/contacts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "contact": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
        "company": "Acme Corp",
        "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",
          "startedAt": "2024-01-15T10:30:00.000Z",
          "endedAt": "2024-01-15T10:32:30.000Z",
          "durationSeconds": 150
        }
      ],
      "createdAt": "2024-01-15T10:30:00.000Z",
      "status": "CONNECTED"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}

Authorizations

​
Authorization
string
header
required

Enter your API Key (sk_live_xxx or sk_test_xxx)

Path Parameters

​
id
string
required

Query Parameters

​
page
number
default:1

Page number (1-indexed)

Required range: x >= 1
Example:

1

​
limit
number
default:50

Number of items per page

Required range: 1 <= x <= 100
Example:

50

​
tag
string

Filter contacts by tag label

Example:

"hot-lead"

​
status
enum<string>

Filter contacts by call status

Available options:
CONNECTED,
RESPONDER,
ERROR,
CANCELLED,
RUNNING,
MISSING_NUMBER
Example:

"CONNECTED"

Response

Paginated list of sequence contacts with tags and calls

​
data
object[]
required

Array of sequence contacts

​
total
number
required
Example:

100

​
page
number
required
Example:

1

​
limit
number
required
Example:

10

​
totalPages
number
required
Example:

10