API ReferenceCampaigns

List campaign contacts

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Path parameters

campaignIdstringRequiredformat: "uuid"
Campaign ID

Query parameters

statusenumOptional
Filter by derived contact status
searchstringOptional

Case-insensitive search over phone number, name and email

limitlongOptional

Max items to return (1-100)

offsetintegerOptional>=0Defaults to 0
Items to skip

Response

Campaign contacts list
contactslist of objects
List of campaign contacts for the current page
metaobject
Pagination metadata

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error