List campaigns
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.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Path Parameters
Workspace slug (GET /me lists yours).
Query Parameters
Items per page, 1 to 200. Default 50.
1 <= value <= 200The 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"{
"data": [
{
"id": "string",
"name": "string",
"status": "string",
"agentId": "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
}List a campaign's recipients GET
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.
Pause a campaign POST
Pause a RUNNING campaign so the dialer stops originating new calls. In-flight calls still finish and settle. Only a running campaign can be paused. Resume it later with resume_campaign.