API ReferenceCampaigns

Get a campaign

GET /api/v1/campaign/{id} — single campaign with stats and config.

GET /api/v1/campaign/{campaign_id}

Response

Same shape as a single item from GET /campaign. The response uses state (not status), and includes retry_config, schedule_config, circuit_breaker, telephony_configuration_id / telephony_configuration_name, and the structured logs[] array of campaign events (circuit-breaker trips, phone-pool exhaustion, source-sync issues).

Examples

curl https://dashboard.zoxa.ai/api/v1/campaign/7 \
  -H "X-API-Key: zsk_..."

Errors

Status	`detail`	When
`404`	`"Campaign not found"`	Id not in your org.

List campaigns

GET /api/v1/campaign — a paginated page of your organization's campaigns with per-campaign outcome stats.

Update a campaign

PATCH /api/v1/campaign/{id} — change name, concurrency, retry, schedule, or circuit-breaker. Locked once completed, failed, or archived.

Get a campaign

Response

Examples

Errors

On this page