Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Brand-Slug
enum<string>
default:hi-doctor

Send X-Brand-Slug: hi-doctor. Public auth/questionnaire/attribution routes resolve the brand header; authenticated scope also uses the live user brand. Do not claim the header is universally server-required: default-brand fallback exists.

Available options:
hi-doctor

Path Parameters

id
string<uuid>
required

Identifier returned by the corresponding authorized collection; use only a record visible to the signed-in patient.

Response

Authorized consultation image metadata.

id
string<uuid>
required

Image identifier.

url
string<uri>
required

Authorized image content URL.

filename
string
required

Display filename.

uploaded_at
string<date-time>
required

Upload timestamp.

consultation_id
string<uuid>
required

Owning consultation identifier.

available
boolean
required

Whether this image remains available.

source
string

Present for an image originally supplied through the questionnaire.

question_key
string | null

Question key for a questionnaire image; null if unavailable.