List campaign contacts

Browse a campaign’s contacts with limit and offset pagination, filter by contact status, or search for a specific number.

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

List campaign contacts

cURL

curl --request GET \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/contacts \
  --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}/contacts

Browse contact state for a campaign.

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

The campaign whose contacts you want to browse.

limit · integer · default: "20"

Number of contacts to return per page.

offset · integer · default: "0"

Number of contacts to skip before returning results.

status · string

Filter by contact state: pending, dialling, answered, no_answer, busy, failed, retry_pending, or expired.

search · string

Find a specific destination number.

Example

cURL

curl "https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/contacts?limit=20&offset=0&status=answered" \
  -H "X-Auth-ID: {account_id}" \
  -H "X-Auth-Token: {auth_token}"

The response is { objects, total }, where total is the unpaginated count for the applied filters.