List campaigns

GET

https://api.v2.rasen.ai/v1/campaigns

GET

/v1/campaigns

curl https://api.v2.rasen.ai/v1/campaigns \
     -H "Authorization: Bearer <api_key>"

{
  "items": [
    {
      "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"
    }
  ],
  "next_cursor": "string"
}

List campaigns.

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.

Query parameters

limitintegerOptional1-200Defaults to 50

Page size; 50 by default, at most 200.

cursorstringOptional

Opaque cursor bound to the workspace, every filter, grouping and limit. Send them unchanged with it. Expires after 24 hours.

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.

Response

List campaigns.

itemslist of objects

next_cursorstring or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error