List campaigns in the workspace

GET

/v1/campaigns

Returns campaigns ordered by creation time, newest first. Filter by status. Pagination is opaque-cursor; pass the previous response’s next_page_token to fetch the next page.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

statusenumOptional

Allowed values:

page_sizeintegerOptional

page_tokenstringOptional

Response

Paginated list of campaigns

campaignslist of objects

next_page_tokenstring

Errors

401

List Campaigns Request Unauthorized Error

1	{
2	"campaigns": [
3	{
4	"id": "id",
5	"workspace_id": "workspace_id",
6	"channel": "voice",
7	"agent_id": "agent_id",
8	"status": "draft",
9	"config": {
10	"key": "value"
11	},
12	"schedule": {
13	"key": "value"
14	},
15	"retry_policy": {
16	"key": "value"
17	},
18	"created_at": "2024-01-15T09:30:00Z",
19	"updated_at": "2024-01-15T09:30:00Z",
20	"started_at": "2024-01-15T09:30:00Z",
21	"completed_at": "2024-01-15T09:30:00Z",
22	"retryable_failed": 1
23	}
24	],
25	"next_page_token": "next_page_token"
26	}

$	curl https://api.voicebip.com/v1/campaigns \
>	-H "Authorization: Bearer <token>"