Skip to main content
GET
Returns the full campaign object.

Authentication

X-API-Key
string
required
Project API key for this organization and project. Format: bot_live_…

Path parameters

organization_id
string
required
Organization ID. Must match the API key.
project_id
string
required
Project ID. Must match the API key.
campaign_id
string
required
Campaign ID.

Response

_id
string
required
Campaign ID.
name
string
required
Campaign name.
status
string
required
One of draft, running, paused, completed, cancelled.
call_direction
string
required
outbound or inbound.
campaign_type
string
required
workflow, static, or whatsapp.
workflow_id
string
Workflow ID when campaign_type is workflow.
phone_numbers
array
Caller ID numbers for outbound campaigns.
list_ids
array
Customer list IDs used for bulk dialing.
created_at
datetime
Creation timestamp.
updated_at
datetime
Last update timestamp.

Errors

401
Unauthorized
Missing, invalid, or revoked API key.
403
Forbidden
API key is not authorized for this organization or project.
404
Not Found
Campaign not found.