Campaigns

List campaigns

GET /v1/campaigns

Scope

campaigns:read

Tier

Tier 1

Data

Account data

Idempotency

Idempotency-Key: not used

Limit

Up to 100 per page (default 50)

Archived campaigns are not listed.

Parameters

Response

200: One page of campaigns.

Examples

Request example

curl

curl -sS -X GET \
  "https://app.dialerbee.com/api/v1/campaigns?limit=50" \
  -H "Authorization: Bearer $DIALERBEE_API_KEY"

Python (SDK)

from dialerbee import DialerBee

db = DialerBee()  # reads DIALERBEE_API_KEY from the environment

page = db.campaigns.list(limit=50)
for item in page:  # this page, then every following page
    print(item.id)

Response example

200

{
  "data": [
    {
      "id": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e",
      "name": "Autumn renewals",
      "status": "paused",
      "dialer_mode": "progressive",
      "created_at": "2026-09-29T09:15:00Z",
      "updated_at": "2026-09-29T09:20:00Z",
      "started_at": "2026-09-29T11:58:00Z",
      "completed_at": null
    }
  ],
  "page": {
    "next_cursor": "c1.example-opaque-cursor",
    "has_more": true
  }
}

Error examples

400 invalid_cursor

{
  "type": "https://docs.dialerbee.com/errors/invalid-cursor",
  "title": "Invalid cursor",
  "status": 400,
  "detail": "The cursor is not valid for this request: it was changed, it belongs to another list or other filters, or it expired.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "invalid_cursor",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

403 insufficient_scope

{
  "type": "https://docs.dialerbee.com/errors/insufficient-scope",
  "title": "Not permitted",
  "status": 403,
  "detail": "The API client does not hold the scope this operation requires.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "insufficient_scope",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

401 invalid_api_key

{
  "type": "https://docs.dialerbee.com/errors/invalid-api-key",
  "title": "Invalid API key",
  "status": 401,
  "detail": "The Authorization header is missing, is not Bearer dbk_live_..., or the key is not recognised, has expired or was revoked (one answer for every key problem, so a key's state is never revealed).",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "invalid_api_key",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

Errors

Objects

CampaignList

Page

Pass next_cursor as cursor to get the next page. null means this is the last page.

Campaign