Skip to main content
GET
Retrieve a campaign

Authorizations

Authorization
string
header
required

Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.

Path Parameters

id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

Response

The a campaign

id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

object
enum<string>
required
Available options:
campaign
name
string
required
agent_id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

status
enum<string>
required
Available options:
idle,
scheduled,
running,
completed,
stopped,
paused
paused_reason
string | null
required
lead_count
integer
required
scheduled_at
string<date-time> | null
required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"

created_at
string<date-time>
required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"