Campaigns

Get Campaign V2 Contacts

Authentication

AuthorizationBearer
Authenticate server-side requests with a private Vapi API key. Create or copy a key from the [Vapi Dashboard](https://dashboard.vapi.ai) and send it in the `Authorization` header as `Bearer <token>`. Keep private API keys out of client-side code and public repositories.

Path parameters

idstringRequiredformat: "uuid"
The unique identifier for the resource.

Query parameters

statuslist of enumsOptional
This is the status to filter contacts by. Pass once or multiple times to filter on any of the provided statuses.
limitdoubleOptional1-1000
This is the maximum number of contacts to return. Defaults to 50.
sortByenumOptional
This is the column to sort by. Defaults to `position` — the order contacts were uploaded, which is also dial order. `status` sorts by the enum's declaration order rather than alphabetically, which means it reads as a lifecycle: pending, dispatched, completed, failed, skipped, predial-failed. Only columns on `campaign_contact` are sortable. Call-level values such as cost or duration live on the call and are attached after this query, so sorting by them here would only reorder the current page.
Allowed values:
pagedoubleOptional>=1
This is the page number to return. Defaults to 1.

Response

resultslist of objects
metadataobject
Pagination and retention metadata returned with a paginated list of phone numbers.