Campaigns

List campaigns

Retrieve a paginated list of dialer campaigns for your organization.

Supports optional filtering by campaign status:
- `draft` — Campaign is being configured
- `scheduled` — Campaign is scheduled to start
- `running` — Campaign is actively placing calls
- `paused` — Campaign has been paused
- `completed` — All contacts have been processed
- `stopped` — Campaign was manually stopped
- `failed` — Campaign encountered a fatal error

Supports optional search by campaign name (case-insensitive substring match).

Campaigns are returned in reverse chronological order (newest first).

Authentication:
- API key with READ or READ_WRITE permission
get/campaigns

Request

  • Base URL: https://api.yourang.ai/v1
  • URL: https://api.yourang.ai/v1/campaigns
  • Auth: API Key (a scheme the document does not define)

Query parameters

statusstring nullable

Filter by campaign status (draft, scheduled, running, paused, completed, stopped, failed)

searchstring nullable

Case-insensitive substring search on campaign name

limitinteger

Number of items to return

offsetinteger

Number of items to skip

Response

Successfully retrieved campaign list

unknown required

Changes

No recorded changes to this endpoint across all 8 revisions of this API.