Skip to main content
GET
Read an offering's composed qualification questions

Authorizations

Authorization
string
header
required

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

Headers

X-Brand-Id
string
required

Your brand id (brd_...). It must be one of the brands your API key's account owns; with a publishable key it must be the one brand the key was issued for. A missing or malformed value is refused with 400, and an unknown or foreign brand with 404.

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

Path Parameters

offering_ref
string
required

Query Parameters

mode
enum<string>
required
Available options:
initial,
refill

Response

the composed qualification overlay for the offering

the offering's questions under data, in the order a patient will meet them

data
object[]
required