curl "https://api.nedzo.ai/v1/campaigns?workspaceId=789e4567-e89b-12d3-a456-426614174000&status=live" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"items": [{
"id": "123e4567-e89b-12d3-a456-426614174000",
"workspaceId": "789e4567-e89b-12d3-a456-426614174000",
"name": "September promo",
"voiceAgentId": "aaa11111-bbbb-2222-cccc-333344445555",
"savedViewId": "bbb11111-bbbb-2222-cccc-333344445555",
"dailyCapTalkMinutes": 120,
"maxFollowUps": 2,
"callingDays": [1, 2, 3, 4, 5],
"callingHoursStart": "09:00:00",
"callingHoursEnd": "17:00:00",
"callingTimezone": null,
"status": "draft",
"createdAt": "2026-10-11T12:00:00Z",
"updatedAt": "2026-10-11T12:00:00Z"
}],
"total": 1,
"limit": 50,
"offset": 0,
"hasMore": false
}
Campaigns
List campaigns
List the campaigns in a workspace, newest first.
GET
/
campaigns
curl "https://api.nedzo.ai/v1/campaigns?workspaceId=789e4567-e89b-12d3-a456-426614174000&status=live" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"items": [{
"id": "123e4567-e89b-12d3-a456-426614174000",
"workspaceId": "789e4567-e89b-12d3-a456-426614174000",
"name": "September promo",
"voiceAgentId": "aaa11111-bbbb-2222-cccc-333344445555",
"savedViewId": "bbb11111-bbbb-2222-cccc-333344445555",
"dailyCapTalkMinutes": 120,
"maxFollowUps": 2,
"callingDays": [1, 2, 3, 4, 5],
"callingHoursStart": "09:00:00",
"callingHoursEnd": "17:00:00",
"callingTimezone": null,
"status": "draft",
"createdAt": "2026-10-11T12:00:00Z",
"updatedAt": "2026-10-11T12:00:00Z"
}],
"total": 1,
"limit": 50,
"offset": 0,
"hasMore": false
}
This endpoint is for the VIP plan only. Other plans get a
403. See Plan access.string
The workspace. Required for an account key. A workspace key uses its own workspace.
string
Only campaigns with this status:
draft, live, paused, capped, out_of_funds or completed.integer
default:"50"
Campaigns per page, 1 to 100.
integer
default:"0"
Campaigns to skip, up to 100,000.
Status
| Status | What it means |
|---|---|
draft | Not calling yet. |
live | Calling inside its days and hours. |
paused | Stopped by a person. Only a person starts it again. |
capped | Used its talk minutes for the day. It starts again on the next calling day by itself. |
out_of_funds | The account has no minutes or balance left. It starts again by itself when the account can pay. |
completed | Finished. |
draft, live, paused and completed. The dialer sets capped and out_of_funds.
curl "https://api.nedzo.ai/v1/campaigns?workspaceId=789e4567-e89b-12d3-a456-426614174000&status=live" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"items": [{
"id": "123e4567-e89b-12d3-a456-426614174000",
"workspaceId": "789e4567-e89b-12d3-a456-426614174000",
"name": "September promo",
"voiceAgentId": "aaa11111-bbbb-2222-cccc-333344445555",
"savedViewId": "bbb11111-bbbb-2222-cccc-333344445555",
"dailyCapTalkMinutes": 120,
"maxFollowUps": 2,
"callingDays": [1, 2, 3, 4, 5],
"callingHoursStart": "09:00:00",
"callingHoursEnd": "17:00:00",
"callingTimezone": null,
"status": "draft",
"createdAt": "2026-10-11T12:00:00Z",
"updatedAt": "2026-10-11T12:00:00Z"
}],
"total": 1,
"limit": 50,
"offset": 0,
"hasMore": false
}
Was this page helpful?
