Skip to main content
GET
Read a patient's public enrollment status

Authorizations

Authorization
string
header
required

Per-client API key (M2M). Presented as Authorization: Bearer <key>.

Headers

X-Brand-Id
string
required

Opaque brand id (brd_…). Names which of your brands the enrollment belongs to; validated to belong to the authenticated client.

Pattern: ^brd_[A-Za-z0-9][A-Za-z0-9_-]*$

Path Parameters

journey_id
string
required
Pattern: ^jny_[A-Za-z0-9][A-Za-z0-9_-]*$

Response

the partner-visible status projection

The public enrollment-status read — identifiers and a status value only, never patient data.

journey_id
string
required
Pattern: ^jny_[A-Za-z0-9][A-Za-z0-9_-]*$
public_status
enum<string>
required

The versioned public enrollment-status value. Each value is stable within v1 — a semantic change is published as a new version, never an in-place edit. The status reflects order authority: a patient never shows APPROVED before an order is authorized. Some later statuses (PREPARING, SHIPPED, DELIVERED, REFILL_DUE) are declared now so the contract is complete; their producers arrive with the shipment features.

Available options:
RECEIVED,
IN_REVIEW,
ACTION_NEEDED,
APPROVED,
DECLINED,
ON_HOLD,
PREPARING,
SHIPPED,
DELIVERED,
SUPERSEDED,
REFILL_DUE
status_version
enum<string>
required
Available options:
v1