Retrieve a campaign

Fetch a single campaign with its status, computed health, outcome counters, caller-ID configuration, schedule, and pause reason.

GET /api/v1/account/{account_id}/campaigns/{campaign_id}

Retrieve a campaign

cURL

curl --request GET \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id} \
  --header 'X-Auth-ID: <x-auth-id>' \
  --header 'X-Auth-Token: <api-key>'

GET https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}

Returns status, outcome counters, capacity settings, caller-ID strategy, schedule, daily window, pause reason, webhook URL, and timestamps.

Authentication required

• X-Auth-ID — your Vobiz account ID
• X-Auth-Token — your Vobiz auth token

account_id · string · required

Your Vobiz account ID. Use the same value in X-Auth-ID.

X-Auth-ID · string · required

Your Vobiz account ID, for example MA_XXXXXXXX.

campaign_id · string · required

ID of the campaign, returned by Create a campaign.

Example

cURL

curl "https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}" \
  -H "X-Auth-ID: {account_id}" \
  -H "X-Auth-Token: {auth_token}"

Computed health

For a running campaign, health is derived from recent dial activity.

Value	Meaning
active	Calls are being placed.
idle	Running but not currently dialling — for example while account capacity is saturated.
stalled	No recent dial beyond the watchdog threshold.
not_started	No dial has occurred yet.

See Capacity and monitoring for the pause reasons that can accompany a paused status.