Skip to content

Patient form intro info

GET
/v1/sessions/{token}/info

Public endpoint. Returns intro/branding info for the patient-facing hosted form. No auth required — the unguessable token IS the credential.

Parameters

Path Parameters

token
required
string

Responses

200

OK

object
status
string
Allowed values: pending active completed expired
type

Server-side aliases: emergency-summaryemergency, pre-anc-visitpre-consult.

string
Allowed values: pre-consult clinical-note discharge referral transfer medication lab-requisition history international emergency emergency-summary pre-anc-visit pre-visit-clinic care-plan radiology
specialty
string
nullable
language
string
en
expires_at
string format: date-time
patient_first_name
string
nullable
doctor
string
nullable
doctor_credentials
string
nullable
clinic_name
string
nullable
logo_url
string format: uri
nullable
primary_color
string
nullable
appointment_date
string format: date-time
nullable

404

Invalid link

object
error
required
string
Invalid link
code
integer
1003

410

Session expired

object
error
required
string
Invalid link
code
integer
1003