Get one campaign | Rasen Developer API

{
  "id": "string",
  "revision": "string",
  "agent_id": "string",
  "name": "string",
  "state": "string",
  "recipient_count": 1,
  "max_attempts_per_recipient": 1,
  "retry_backoff_ms": 1,
  "max_concurrent_calls": 1,
  "dialing_time_zone": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "progress": {
    "recipients": {},
    "attempts": {},
    "terminal": 1,
    "remaining": 1,
    "percent_complete": 1,
    "complete": true,
    "held": 1,
    "attempted": 1,
    "pickup_rate": 1,
    "average_answered_ms": 1,
    "talk_time_ms": 1
  },
  "ringing_timeout_seconds": 1,
  "from_phone_number_id": "string",
  "window_start_at": "2024-01-15T09:30:00Z",
  "window_end_at": "2024-01-15T09:30:00Z",
  "daily_opens_minute": 1,
  "daily_closes_minute": 1,
  "quota_checked_at": "2024-01-15T09:30:00Z",
  "failure_reason": "string",
  "started_at": "2024-01-15T09:30:00Z",
  "ended_at": "2024-01-15T09:30:00Z"
}

Get one campaign.

Authentication

AuthorizationBearer

Create and manage workspace-owned keys through the existing app session routes, outside this public API. Creator and manager identities are audit actors only. Key validity follows workspace policy, expiry and explicit revocation, independently of creator membership. Do not include a workspace-selection header.

Path parameters

campaign_idstringRequired1-128 characters

Campaign identity within the authenticated workspace.

Response headers

X-Request-IdstringOptional

Safe server request correlation ID.

RateLimit-LimitintegerOptional

Requests allowed in the current window for the tightest applicable limit.

RateLimit-RemainingintegerOptional

Requests left in the current window.

RateLimit-ResetintegerOptional

Seconds until the current window resets.

ETagstringOptional

Strong campaign revision. Use it as If-Match for state-dependent commands.

Response

Get one campaign.

idstring<=128 characters

revisionstring

agent_idstring<=128 characters

namestring<=200 characters

statestring

recipient_countinteger>=0

max_attempts_per_recipientinteger1-10

retry_backoff_msinteger>=0

max_concurrent_callsinteger1-1000

dialing_time_zonestring<=64 characters

created_atdatetime

updated_atdatetime

progressobject

ringing_timeout_secondsinteger or nullOptional5-120

from_phone_number_idstring or nullOptional<=128 characters

window_start_atdatetime or nullOptional

window_end_atdatetime or nullOptional

daily_opens_minuteinteger or nullOptional0-1440

daily_closes_minuteinteger or nullOptional0-1440

quota_checked_atdatetime or nullOptional

failure_reasonstring or nullOptional

started_atdatetime or nullOptional

ended_atdatetime or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error