Get campaign

Retrieve a single campaign by ID

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

cURL

curl -X GET "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/campaigns/CAMPAIGN_ID" \
  -H "X-API-Key: bot_live_YOUR_KEY"

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

import os
import requests

response = requests.get(
    f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/campaigns/{campaign_id}",
    headers={"X-API-Key": os.environ["BOTCADENCE_API_KEY"]},
)
campaign = response.json()["data"]

200

{
  "status": "success",
  "message": "Campaign retrieved successfully",
  "data": {
    "_id": "665f1a2b3c4d5e6f7a8b9c0d",
    "name": "January Sales Outreach",
    "description": "Follow up with trial users",
    "status": "draft",
    "call_direction": "outbound",
    "campaign_type": "workflow",
    "workflow_id": "665e00000000000000000001",
    "phone_numbers": [
      { "number": "[phone]", "provider": "twilio" }
    ],
    "list_ids": ["665d00000000000000000001"],
    "timezone": "America/Los_Angeles",
    "start_time": "09:00",
    "end_time": "17:00",
    "call_days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
    "recording_enabled": true,
    "call_summary_enabled": true,
    "created_at": "2026-07-01T10:00:00Z",
    "updated_at": "2026-07-01T10:00:00Z"
  },
  "status_code": 200
}

{
  "status": "error",
  "message": "Campaign not found",
  "data": null,
  "status_code": 404
}

Returns the full campaign object.

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.

campaign_id · string · required

Campaign ID.

Response

_id · string · required

Campaign ID.

name · string · required

Campaign name.

status · string · required

One of draft, running, paused, completed, cancelled.

call_direction · string · required

outbound or inbound.

campaign_type · string · required

workflow, static, or whatsapp.

workflow_id · string

Workflow ID when campaign_type is workflow.

phone_numbers · array

Caller ID numbers for outbound campaigns.

list_ids · array

Customer list IDs used for bulk dialing.

created_at · datetime

Creation timestamp.

updated_at · datetime

Last update timestamp.

Errors

401 · Unauthorized

Missing, invalid, or revoked API key.

403 · Forbidden

API key is not authorized for this organization or project.

404 · Not Found

Campaign not found.

cURL

curl -X GET "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/campaigns/CAMPAIGN_ID" \
  -H "X-API-Key: bot_live_YOUR_KEY"

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

import os
import requests

response = requests.get(
    f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/campaigns/{campaign_id}",
    headers={"X-API-Key": os.environ["BOTCADENCE_API_KEY"]},
)
campaign = response.json()["data"]

200

{
  "status": "success",
  "message": "Campaign retrieved successfully",
  "data": {
    "_id": "665f1a2b3c4d5e6f7a8b9c0d",
    "name": "January Sales Outreach",
    "description": "Follow up with trial users",
    "status": "draft",
    "call_direction": "outbound",
    "campaign_type": "workflow",
    "workflow_id": "665e00000000000000000001",
    "phone_numbers": [
      { "number": "[phone]", "provider": "twilio" }
    ],
    "list_ids": ["665d00000000000000000001"],
    "timezone": "America/Los_Angeles",
    "start_time": "09:00",
    "end_time": "17:00",
    "call_days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
    "recording_enabled": true,
    "call_summary_enabled": true,
    "created_at": "2026-07-01T10:00:00Z",
    "updated_at": "2026-07-01T10:00:00Z"
  },
  "status_code": 200
}

{
  "status": "error",
  "message": "Campaign not found",
  "data": null,
  "status_code": 404
}