Skip to main content
GET
/
campaigns
/
{campaignId}
/
contacts
Get all contacts by campaign ID
curl --request GET \
  --url https://api.callers.ai/campaigns/{campaignId}/contacts \
  --header 'Authorization: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "phoneNumber": "<string>",
    "campaignId": "<string>",
    "status": "<string>",
    "attempts": 123,
    "createdAt": "<string>",
    "lastAttempt": "<string>",
    "failedReason": "<string>",
    "failedReasonDetails": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Headers

​
x-sub-organization-id
string

Optional sub organization ID. Must belong to your main organization API key.

Path Parameters

​
campaignId
string
required

Id of the campaign as a string ObjectId value.

Query Parameters

​
lastAttemptTo
string

Filter contacts up to this last attempt date in ISO 8601 UTC format (e.g. YYYY-MM-DDTHH:mm:ss.sssZ). Default is null.

​
lastAttemptFrom
string

Filter contacts from this last attempt date in ISO 8601 UTC format (e.g. YYYY-MM-DDTHH:mm:ss.sssZ). Default is null.

​
archived
boolean

Archived filter. Default is false.

​
sortDirection
string

Sorting direction. Default is ascending. Possible values: 'asc' or 'desc'.

​
sortAttribute
string

Sorting attribute. Name of the entity field to sort by.

​
isEnabledSuccessCriteria
boolean

Whether success criteria are enabled. When disabled, goals filtering is ignored. Default: false.

​
goals
string

Goals filter. Default is all goals.

​
statuses
string

Status filter. Default is all statuses.

​
perPage
number

Max page size. Default is 50.

​
page
number

Page number. Default is 0.

Response

default - application/json
​
id
string
required

The id of the contact. string representation of a ObjectId.

​
name
string
required

The name of the contact.

​
phoneNumber
string
required

The phone number of the contact.

​
campaignId
string
required

The id of the campaign. string representation of a ObjectId.

​
status
string
required

The status of the contact.

​
attempts
number
required

The total number of call attempts made to reach the contact.

​
createdAt
string
required

The date and time the contact was created in ISO format.

​
lastAttempt
string
required

The date and time of the last call attempt in ISO format.

​
failedReason
string

The reason for failing the call.

​
failedReasonDetails
string

The reason details for failing the call.