One enrollment

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

One contact's place in a campaign or automation: state, step and why it is paused.

campaigns:readOperation id: get_enrollment

GET/enrollments/{id}

curl -X GET "https://api.norreach.app/v1/enrollments/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

One enrollment

{
  "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"
}

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).

Response

200application/json— One enrollment

idstring (uuid)required

An id (UUID).

object"enrollment"required

campaign_idstring (uuid)required

An id (UUID).

contact_idstring (uuid)required

An id (UUID).

contactobject | nullrequired

statestringrequired

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

current_stepintegerrequired

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

pause_reasonstring | nullrequired

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

next_run_atstring | nullrequired

created_atstringrequired

RFC 3339 UTC timestamp with milliseconds.

updated_atstring | nullrequired

Errors

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

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
404	`not_found`	That doesn't exist.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

GET/enrollments/{id}

curl -X GET "https://api.norreach.app/v1/enrollments/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

One enrollment

{
  "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"
}