Campaigns

List campaign contacts

Page through the campaign’s queue and each contact’s state.

GET/v1/campaigns/{id}/contacts

Authorization

bearerAuth
AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Path Parameters

id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Query Parameters

limit?integer
Default50
Range1 <= value <= 200
offset?integer
Default0
Range0 <= value <= 9007199254740991
status?string

Response Body

application/json

application/json