Skip to main content
GET
Get user profile

Authorizations

Authorization
string
header
required

OAuth 2.1 with PKCE

Response

User profile

The account, its patients, and what it can do right now. Nothing on the profile gates the account: capabilities says what is ready and what each capability still needs, and capabilities.visit.atPayment lists what the visit payment link collects at booking unless saved first.

accountId
string
status
string

ONBOARDED for every first-party account from signup.

tier
enum<string>

linked = at least one insurance connection is ready for the account holder.

Available options:
connected,
linked
capabilities
object

Per capability (conversations, prescriptions, careRequests, pricing, networkStatus, claims, visit): { ready: true } or { ready: false, needs: { field: [sources] } }, plus optional better. Sources: params (pass it on the call), profile (PATCH /api/profile/patient), link (POST /api/connections/insurance), payPage (the visit payment link collects it).

connections
object[]

Every linked source on the account, one entry per patient profile per source.

patients
object[]
regionSupported
boolean
regionNote
string
healthRecords
object

Record counts per category from the account holder's connected insurance; never the records themselves.