Skip to content

Fetch an intake session by token

GET
/v1/intake-sessions/{token}

Returns the full intake session record including result once status is completed.

Authorizations

Parameters

Path Parameters

token
required
string

Responses

200

OK

object
id
string format: uuid
token
string
specialty
string
patient_id
string format: uuid
nullable
appointment_id
string format: uuid
nullable
status
string
Allowed values: pending submitted processing completed failed expired
form_responses
object
patient_name
string
nullable
phone
string
nullable
result
object
summary_id
string format: uuid
nullable
document_id
string format: uuid
nullable
expires_at
string format: date-time
submitted_at
string format: date-time
nullable
completed_at
string format: date-time
nullable
created_at
string format: date-time

404

Session not found

object
error
required
string
Invalid link
code
integer
1003