Get a campaign

curl --request GET \
  --url https://sandbox.voice.miraiminds.co/v2/campaigns/{campaign_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox.voice.miraiminds.co/v2/campaigns/{campaign_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const url = 'https://sandbox.voice.miraiminds.co/v2/campaigns/{campaign_id}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "agent_revision": 1,
  "id": "cmp_01K79Q4T6W8XZ2B5D7F9H3JKMN",
  "object": "campaign",
  "name": "सर्विस रिमाइंडर — अक्टूबर",
  "agent_id": "agt_01K2M4P7QRSTVWXYZ0A1B2C3",
  "tier": "t5",
  "status": "play",
  "pause_reason": null,
  "timezone": "Asia/Kolkata",
  "start_date": "2026-10-12",
  "end_date": "2026-10-16",
  "slots": [
    {
      "start": "10:00",
      "end": "13:00"
    },
    {
      "start": "16:00",
      "end": "19:00"
    }
  ],
  "max_concurrent": 3,
  "retry_count": 1,
  "re_attempt_period_secs": 3600,
  "max_duration_secs": 300,
  "budget_paise": 100000,
  "spent_paise": 1000,
  "skip_called_before": false,
  "final_results": true,
  "created_at": "2026-10-09T06:12:40Z",
  "updated_at": "2026-10-12T04:32:16Z",
  "counters": {
    "completed": 1,
    "dialing": 1,
    "pending": 1
  },
  "archived": false,
  "archived_at": null
}

Campaigns

Get a campaign

The campaign’s settings, status and counters: how many contacts are in each status (pending, dialing, completed, no_answer, busy, failed, voicemail, timeout, exhausted, suppressed, skipped, aborted). Poll it to watch a campaign run.

status is draft, play, paused, stopped or completed. pause_reason says why a campaign paused: insufficient_balance or budget_exhausted when we paused it, the reason you gave when you did, and null otherwise.

GET

campaigns

{campaign_id}

Get a campaign

curl --request GET \
  --url https://sandbox.voice.miraiminds.co/v2/campaigns/{campaign_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox.voice.miraiminds.co/v2/campaigns/{campaign_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const url = 'https://sandbox.voice.miraiminds.co/v2/campaigns/{campaign_id}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "agent_revision": 1,
  "id": "cmp_01K79Q4T6W8XZ2B5D7F9H3JKMN",
  "object": "campaign",
  "name": "सर्विस रिमाइंडर — अक्टूबर",
  "agent_id": "agt_01K2M4P7QRSTVWXYZ0A1B2C3",
  "tier": "t5",
  "status": "play",
  "pause_reason": null,
  "timezone": "Asia/Kolkata",
  "start_date": "2026-10-12",
  "end_date": "2026-10-16",
  "slots": [
    {
      "start": "10:00",
      "end": "13:00"
    },
    {
      "start": "16:00",
      "end": "19:00"
    }
  ],
  "max_concurrent": 3,
  "retry_count": 1,
  "re_attempt_period_secs": 3600,
  "max_duration_secs": 300,
  "budget_paise": 100000,
  "spent_paise": 1000,
  "skip_called_before": false,
  "final_results": true,
  "created_at": "2026-10-09T06:12:40Z",
  "updated_at": "2026-10-12T04:32:16Z",
  "counters": {
    "completed": 1,
    "dialing": 1,
    "pending": 1
  },
  "archived": false,
  "archived_at": null
}

Authorizations

Authorization

string

header

required

Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.

Path Parameters

campaign_id

string

required

The campaign's id (cmp_…).

Response

Running

Get started

Agents

Calls

Flows

Tools and secrets

Campaigns

Do-not-call list

Phone numbers

Phone pools

Telephony

Transcriptions

Speech to text

Text to speech

Wallet

Reference

Get a campaign

Authorizations

Path Parameters

Response