Skip to main content
GET
List campaign contacts
Per-contact state for one campaign, oldest enrollment first. Each row carries the enrollment’s own state machine (status, attempts used, next retry time, why it stopped) with the underlying lead and the last_disposition expanded to the full objects they reference. Use this to answer “what happened to this specific person”. For aggregate counters use GET /campaigns/{id}/stats. Required scope: campaigns:read.

Path parameters

Query parameters

Contact statuses

Row fields

Example request

Example response

lead and last_disposition are abbreviated above; in a real response each is the complete object. last_disposition is null while a call is still being categorized, and stays null for calls that never connected — a last_disconnect_reason with no disposition is the normal shape for an unanswered call.

Errors

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Query Parameters

status
string

Comma-separated list of contact statuses to include.

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

Response

Enrolled contacts

data
object[]
pagination
object
campaign_id
string<uuid>
company_id
string<uuid>