Get a dialer campaign
Returns a single campaign with its full configuration. A campaign belonging to another company reads as 404.
Authorizations
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
Dialer campaign ID.
^[1-9][0-9]*$Response
The campaign.
A dialer campaign. Identifiers are returned as strings because they are 64-bit integers server-side.
Campaign ID.
"42"
Human-readable campaign name.
"Q3 renewals"
Dialing mode.
sequential, parallel "sequential"
Lifecycle status. initializing: created, membership backfill pending. active: the only dialable state. inactive: paused, fully reversible. archived: review/analytics state, not dialable, exits only back to inactive. deleted: soft-deleted, terminal.
initializing, active, inactive, archived, deleted "active"
Per-call behaviour bundle. Every knob is optional — an omitted knob keeps the service default. Stored verbatim, so a bundle read back may also carry knobs added by a newer release.
Allocation-batch and dynamic queue-sizing bundle. Every knob is optional.
Re-dial rules bundle. Every knob is optional.
Campaign start-window bundle. Every knob is optional.
Contact-eligibility expiry bundle — drives how long an allocated contact stays held. Every knob is optional.
Ordered, duplicate-free subset of the waterfall categories.
favorite, rescheduled, retry, fresh Booleans gating what an agent may do to their queue. Deny by default — an omitted key is false.
Linked call-script ID; null when none.
"310"
Linked survey ID; null when none.
"44"
Creation timestamp (ISO 8601, UTC).
"2026-08-01T09:15:00.000Z"
Last-update timestamp (ISO 8601, UTC).
"2026-08-04T11:42:07.000Z"
When the campaign entered archived; cleared on exit, so non-null only while the status is archived.
null
Soft-delete timestamp; null unless the campaign has been deleted.
null