Skip to main content
GET
List dialer campaigns
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).

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 campaigns per page.

Required range: 1 <= x <= 100
status
enum<string>

Return only campaigns in this lifecycle status.

Available options:
initializing,
active,
inactive,
archived,
deleted
include_deleted
boolean
default:false

Set to true to include campaigns whose status is deleted, which are hidden by default. Ignored when status is set. Only the literal strings true and false are accepted — anything else is a 400.

mode
enum<string>

Return only campaigns using this dialing mode.

Available options:
sequential,
parallel

Response

One page of campaigns.

Cursor-paginated page of campaigns. Unlike the legacy CloudTalk endpoints this resource is not wrapped in responseData.

data
object[]

One page of campaigns.

meta
object

Cursor-pagination metadata.