Docs
Campaigns

List a campaign's enrollments

GEThttps://api.norreach.app/v1/campaigns/{id}/enrollments

Who is in the campaign and where each contact is (state, step, why it is paused), newest first, a page at a time. Filter by state.

campaigns:readOperation id: list_campaign_enrollments
GET/campaigns/{id}/enrollments
curl -X GET "https://api.norreach.app/v1/campaigns/{id}/enrollments" \
  -H "Authorization: Bearer $NORREACH_API_KEY"
List a campaign's enrollments
{
  "object": "list",
  "data": [
    {
      "id": "8e9f0a1b-2c3d-4e4f-9a5b-6c7d8e9f0a1b",
      "object": "enrollment",
      "campaign_id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
      "contact_id": "7d1c3b2a-5e4f-4a1b-9c8d-0e1f2a3b4c5d",
      "contact": {
        "name": "Anna Lindqvist",
        "email": "anna@example.com"
      },
      "state": "paused",
      "current_step": 1,
      "pause_reason": "awaiting_approval",
      "next_run_at": null,
      "created_at": "2026-11-04T09:12:33.120Z",
      "updated_at": "2026-11-04T10:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope campaigns:read. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Query parameters

limitintegerquery

Page size (1–200, default 50).

cursorstringquery

The next_cursor of the previous page.

stateenumquery
One of:pendingactivepausedcompletedrepliedsuppressedmeeting_bookedawaiting_engagementwaitingcallingscheduled

Response

200application/json— List a campaign's enrollments

object"list"required
dataobject[]required
Show child attributes
data[].idstring (uuid)required

An id (UUID).

data[].object"enrollment"required
data[].campaign_idstring (uuid)required

An id (UUID).

data[].contact_idstring (uuid)required

An id (UUID).

data[].contactobject | nullrequired
data[].statestringrequired

pending, active, paused, completed, replied, suppressed, meeting_booked …

data[].current_stepintegerrequired

The step (0-based) the contact is on.

data[].pause_reasonstring | nullrequired

Why it is paused (e.g. awaiting_approval, campaign_not_active, no_consent).

data[].next_run_atstring | nullrequired
data[].created_atstringrequired

RFC 3339 UTC timestamp with milliseconds.

data[].updated_atstring | nullrequired
has_morebooleanrequired
next_cursorstring | nullrequired

Errors

Errors are application/problem+json with a stable code.

StatusCodeMeaning
400bad_requestThe request couldn't be read.
400unknown_fieldThe request has a field this operation doesn't know.
400invalid_cursorThat cursor doesn't belong to this list.
401unauthorizedA valid API key is required.
403insufficient_scopeThis API key doesn't have the scope this operation needs.
403feature_not_enabledThe API isn't switched on for this workspace.
404not_foundThat doesn't exist.
429rate_limitedToo many requests. Slow down and try again.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.