Skip to main content
GET
List campaigns
Returns your workspace’s campaigns, newest first, with agent, from_phone_number and stop_dispositions expanded to the full objects they reference. Archived campaigns are excluded. Required scope: campaigns:read.

Query parameters

Statuses

Example request

Example response

Each row carries the full campaign object; the sample above is trimmed to the interesting fields. See GET /campaigns/{id} for the complete field reference. An unknown value in status is not an error — it simply matches nothing, so check pagination.total before concluding a campaign disappeared.

Errors

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Query Parameters

status
string

Comma-separated list of statuses to include, e.g. running,paused_insufficient_credit. Omit for every non-archived campaign.

limit
integer
default:50
Required range: x <= 200
offset
integer
default:0

Response

List of campaigns

data
object[]
pagination
object
company_id
string<uuid>