Skip to main content
GET
List a campaign's contacts
The Dialer is a newly released product surface: depending on your account’s rollout stage, campaigns managed through this API may not yet be visible in your CloudTalk Dashboard.

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Path Parameters

campaignId
string
required

Dialer campaign ID.

Pattern: ^[1-9][0-9]*$

Query Parameters

cursor
string

Opaque cursor taken from meta.nextCursor of a previous page. Pass it back unchanged. Omitting cursor, or sending it empty, starts from the first page — neither is an error. A non-empty cursor this endpoint cannot decode is rejected with 400 and code: "PAGINATION.INVALID_CURSOR" rather than silently restarting the list. Handle it as an error, not as a terminating null cursor: a loop that only stops on null would re-send the same rejected cursor. Drop the stored cursor and restart from a checkpoint you control.

limit
integer
default:50

Maximum number of contacts per page.

Required range: 1 <= x <= 100
queueTag
enum<string>[]

Narrow to one or more queue positions. Repeat the parameter (?queueTag=fresh&queueTag=retry) or comma-separate (?queueTag=fresh,retry). An unknown value is a 400.

Available options:
assigned,
scheduled,
completed,
dnc,
exhausted,
excluded,
fresh,
retry,
rescheduled,
favorite

Case-insensitive substring match over the contact's display name and phone numbers. At most 200 characters.

Maximum string length: 200

Response

One page of campaign contacts with a filtered-set total.

One cursor page of campaign contacts, ordered by dialing eligibility.

data
object[]
meta
object

Pagination block of the campaign-contacts list. Unlike the other dialer lists it carries total.