List campaigns

List campaigns in a project with pagination and filters

GET /organizations/{organization_id}/projects/{project_id}/campaigns

cURL

curl -G "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/campaigns" \
  -H "X-API-Key: bot_live_YOUR_KEY" \
  --data-urlencode "skip=0" \
  --data-urlencode "limit=20" \
  --data-urlencode 'filters={"status":"running"}' \
  --data-urlencode 'sort={"created_at":-1}'

const params = new URLSearchParams({
  skip: "0",
  limit: "20",
  filters: JSON.stringify({ status: "running" }),
  sort: JSON.stringify({ created_at: -1 }),
});

const response = await fetch(
  `https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/campaigns?${params}`,
  { headers: { "X-API-Key": process.env.BOTCADENCE_API_KEY } }
);

import json
import os
import requests

response = requests.get(
    f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/campaigns",
    headers={"X-API-Key": os.environ["BOTCADENCE_API_KEY"]},
    params={
        "skip": 0,
        "limit": 20,
        "filters": json.dumps({"status": "running"}),
        "sort": json.dumps({"created_at": -1}),
    },
)

200

{
  "status": "success",
  "message": "Campaigns retrieved successfully",
  "data": {
    "items": [
      {
        "_id": "665f1a2b3c4d5e6f7a8b9c0d",
        "name": "January Sales Outreach",
        "status": "running",
        "call_direction": "outbound",
        "campaign_type": "workflow",
        "created_at": "2026-07-01T10:00:00Z"
      }
    ],
    "pagination": {
      "total": 42,
      "page": 1,
      "page_size": 20,
      "total_pages": 3,
      "has_next": true,
      "has_prev": false
    }
  },
  "status_code": 200
}

Returns a paginated list of campaigns for the project.

Authentication

X-API-Key · string · required

Project API key for this organization and project. Format: bot_live_…

Path parameters

organization_id · string · required

Organization ID. Must match the API key.

project_id · string · required

Project ID. Must match the API key.

Query parameters

skip · integer · default: "0"

Number of records to skip. Must be >= 0.

limit · integer · default: "20"

Page size. Range: 1–100.

filters · string

JSON object of MongoDB-compatible filters, for example {"status":"running"}.

sort · string

JSON sort object, for example {"created_at":-1}. Defaults to created_at descending.

projection · string

JSON projection object or comma-separated field list.

Response

items · array · required

Campaign objects for the current page.

pagination · object · required

Pagination metadata.

Show properties

total · integer · required

Total matching campaigns.

page · integer · required

Current page (1-based).

page_size · integer · required

Page size used for this request.

total_pages · integer · required

Total number of pages.

has_next · boolean · required

Whether another page exists.

has_prev · boolean · required

Whether a previous page exists.

Errors

401 · Unauthorized

Missing, invalid, or revoked API key.

403 · Forbidden

API key is not authorized for this organization or project.

cURL

curl -G "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/campaigns" \
  -H "X-API-Key: bot_live_YOUR_KEY" \
  --data-urlencode "skip=0" \
  --data-urlencode "limit=20" \
  --data-urlencode 'filters={"status":"running"}' \
  --data-urlencode 'sort={"created_at":-1}'

const params = new URLSearchParams({
  skip: "0",
  limit: "20",
  filters: JSON.stringify({ status: "running" }),
  sort: JSON.stringify({ created_at: -1 }),
});

const response = await fetch(
  `https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/campaigns?${params}`,
  { headers: { "X-API-Key": process.env.BOTCADENCE_API_KEY } }
);

import json
import os
import requests

response = requests.get(
    f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/campaigns",
    headers={"X-API-Key": os.environ["BOTCADENCE_API_KEY"]},
    params={
        "skip": 0,
        "limit": 20,
        "filters": json.dumps({"status": "running"}),
        "sort": json.dumps({"created_at": -1}),
    },
)

200

{
  "status": "success",
  "message": "Campaigns retrieved successfully",
  "data": {
    "items": [
      {
        "_id": "665f1a2b3c4d5e6f7a8b9c0d",
        "name": "January Sales Outreach",
        "status": "running",
        "call_direction": "outbound",
        "campaign_type": "workflow",
        "created_at": "2026-07-01T10:00:00Z"
      }
    ],
    "pagination": {
      "total": 42,
      "page": 1,
      "page_size": 20,
      "total_pages": 3,
      "has_next": true,
      "has_prev": false
    }
  },
  "status_code": 200
}