Campaigns
Campaigns

List a campaign's recipients

List one campaign's recipients, 50 a page, in the order they were added. Each carries its status, attempt count, last and next attempt times, the latest call's outcome, summary and session id, callbackAt and callbackNote when a callback is booked (outcome callback_scheduled until the dialer places it), and stoppedAt when an operator stopped them. Filter by status, by outcome (the value in each recipient's outcome field, e.g. 'completed', 'voicemail', 'busy', or 'stopped' for recipients stopped with stop_campaign_recipient), to converted recipients only, or search by name or phone. Use get_campaign_recipient for one recipient's full attempt history.

GET
/workspaces/{workspace}/campaigns/{campaign}/recipients

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token from Settings > API tokens.

In: header

Path Parameters

workspace*string

Workspace slug (GET /me lists yours).

campaign*string

Query Parameters

status?string

Only recipients with this status.

Value in"pending" | "calling" | "analysing" | "completed" | "no_answer" | "failed" | "cancelled"
outcome?string

Only recipients whose outcome is exactly this.

converted?boolean

Only recipients the campaign counts as converted (its convertedOutcomes).

search?string

Part of a recipient's name or phone number.

page?integer

Page number, from 1.

Range1 <= value <= 9007199254740991
limit?integer

Items per page, 1 to 200. Default 50.

Range1 <= value <= 200
cursor?string

The next_cursor of the previous page.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/workspaces/string/campaigns/string/recipients"
{
  "data": [
    {
      "id": "string",
      "phoneNumber": "string",
      "status": "string",
      "property1": null,
      "property2": null
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}

Launch a campaign POST

Launch a DRAFT campaign now, which starts real outbound dialing, or pass schedule to start it later: the campaign becomes scheduled and the dialer starts it once that time passes. A SCHEDULED campaign can be launched again to move its start or, without schedule, to start it now; cancel_campaign cancels it. Requires consentConfirmed: true at launch and at every reschedule (you confirm you hold the required calling consents: ACMA / Do Not Call Register) and a caller number: fromNumber, or the campaign's own. It runs the readiness check get_campaign shows and refuses with error not_ready while any blocker remains (an unpublished agent, no caller number, a number in the pool the workspace doesn't own, no pending recipient, a required {{token}} no recipient has, consent unconfirmed), returning readiness: { blockers, warnings } so you can fix every blocker at once. Warnings such as no spend cap or failing campaign-call tests never stop it; call get_campaign first to read them out to the user. Launching never runs a test. Dialing must be enabled server-side for this environment, so on an environment where it is switched off this reports disabled and places no call.

List campaigns GET

List a workspace's outbound campaigns, newest first. Each carries its status (draft, scheduled, running, paused, completed, cancelled), the agent that runs it, and per-status recipient counts (pending, calling, completed, no_answer, failed, cancelled). Call this to find a campaign id for the other campaign tools.