Skip to main content
GET
Get a campaign

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header as: Authorization: Bearer <your-api-key>

Path Parameters

campaign_id
integer
required

Response

Campaign details

id
integer

Unique identifier.

name
string

Campaign name.

type
enum<string>

Campaign type (always outbound).

Available options:
outbound
status
enum<string>

Current campaign status.

Available options:
Scheduled,
Running,
Stopped,
Completed,
Failed,
Expired,
Paused
bot_uid
string

Bot UID for API reference.

from_number
string

Phone number used to dial from (E.164 format).

contact_list_id
integer

Associated contact list ID.

time_start
string

Daily calling window start time in HH:MM format.

time_end
string

Daily calling window end time in HH:MM format.

timezone
string

Calling window timezone (IANA format).

days
enum<string>[]

Days of week the campaign runs on (for recurring campaigns).

Available options:
Monday,
Tuesday,
Wednesday,
Thursday,
Friday,
Saturday,
Sunday
schedule_type
enum<string>

Schedule type: single (one-time) or multi (recurring on specific days).

Available options:
single,
multi
current_index
integer

Number of contacts already called.

total_contacts
integer

Total number of contacts in the campaign's contact list.

created_at
string<date-time>
updated_at
string<date-time>