Skip to navigation

List campaign contacts

Returns the contacts of a campaign, newest first, one page at a time. Each item has the phone number, the status of the contact, how many times it was dialed, the last call (read it with GET /calls/{call_id}) and whether the agent reached its goal. The variables you sent with each contact are never returned. Required scope: campaigns:read. With a test key (vx_test_) it behaves exactly as with a live key and consumes nothing.

Authentication

AuthorizationBearer
API key created by an Owner or Admin of the organization. Never in the query string.

Path parameters

campaign_idstringRequiredformat: "uuid"

Id of the campaign, as returned by POST /campaigns or GET /campaigns.

Headers

VoxAI-VersionenumOptional

API version for this request; defaults to the version the key is pinned to.

Allowed values:

Query parameters

limitintegerOptional1-100Defaults to 20
Maximum number of items in the page, from 1 to 100. Default 20.
cursorstringOptional1-400 characters

Opaque cursor from next_cursor of the previous page, to read the next one. Pass it back unchanged, with the same filters; omit it for the first page.

Response

Successful response.
datalist of objects
The items of this page, in the requested order.
has_moreboolean

true if there are more items after this page.

next_cursorstring or null

Pass it as cursor to read the next page; null on the last page.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error