List campaign agents

Retrieve every non-archived Campaign Manager agent on your account with limit and offset pagination.

GET /api/v1/account/{account_id}/campaign/agents

List campaign agents

cURL

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

GET https://api.vobiz.ai/api/v1/account/{account_id}/campaign/agents

Returns every non-archived agent on the account.

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.

limit · integer · default: "20"

Number of agents to return per page.

offset · integer · default: "0"

Number of agents to skip before returning results.

Example

cURL

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

Response

200 OK

{
  "objects": [
    {
      "id": "9f1c4b6a-2f0e-4a3d-8b21-6c5f0d9a7e42",
      "name": "Appointment Reminder Agent",
      "answer_url": "https://example.com/answer",
      "answer_method": "POST"
    }
  ],
  "total": 5,
  "limit": 20,
  "offset": 0
}

Archived agents are excluded. total reflects the unpaginated count.