Skip to the content

List a Campaign's enrollments

GET /v1/campaigns/{campaign_id}/contacts

Property	Value
Operation	`list_campaign_enrollments`
Group	Campaigns
Scope	`campaigns:read`
Route class	`read`
Idempotency	No `Idempotency-Key`
Audit	Not audited: Ids, statuses, codes and counts; no variables.
Released in	1.65.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Lists the enrollments of a Campaign, newest first, optionally by status, disposition and arm (1.65.0): ids, statuses, dispositions, attempts and Call and Outcome ids, never variables.

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/cmp_.../contacts" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/campaigns/cmp_.../contacts`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/campaigns/cmp_.../contacts",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`campaign_id`	path	CampaignId	yes	The id of a Campaign: `cmp_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`limit`	query	integer	no	The page size, 1 to 100.
`cursor`	query	string	no	The opaque `next_cursor` of the previous page; it binds the filters it was issued under.
`status`	query	CampaignEnrollmentStatus	no
`disposition`	query	CampaignDisposition	no
`arm`	query	CampaignArmKey	no

Responses

Status	Content type	Shape	Error codes
`200`	`application/json`	CampaignEnrollmentList
`400`	`application/json`	ErrorEnvelope	`invalid_request`, `invalid_cursor`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`
`404`	`application/json`	ErrorEnvelope	`not_found`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` answer

The shape is CampaignEnrollmentList.

Field	Type	Required	Description
`data`	array of CampaignEnrollment	yes	The enrollments of a Campaign of this page, newest first.
`has_more`	boolean	yes	True when a further page exists.
`next_cursor`	string or null	yes	The cursor of the next page, or null on the last page.
`object`	`"list"`	yes