VocalDocscontracts 1.65.0

List Campaigns

GET /v1/campaigns

PropertyValue
Operationlist_campaigns
GroupCampaigns
Scopecampaigns:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: Configuration, ids and counts; a Campaign holds no Contact content.
Released in1.65.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Lists the Campaigns of the environment of the credential, newest first, optionally by status, archived ones only on archived=true (1.65.0).

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the campaigns:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/campaigns" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
statusqueryCampaignStatusnoOnly the Campaigns in this status.
archivedqueryone of "true", "false"noArchived Campaigns are left out unless true.

Responses

StatusContent typeShapeError codes
200application/jsonCampaignList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is CampaignList.

FieldTypeRequiredDescription
dataarray of CampaignyesThe Campaigns of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes