Campaigns

Get Campaign V2 Contacts

get/v2/campaign/{id}/contacts

Path parameters

idstring uuid required

The unique identifier for the resource.

Query parameters

statusstring[]

This is the status to filter contacts by. Pass once or multiple times to filter on any of the provided statuses.

limitnumber

This is the maximum number of contacts to return. Defaults to 50.

sortBy'position' | 'status'

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.

pagenumber

This is the page number to return. Defaults to 1.

Response

Changes