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.

Query Parameters

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Response

Successful list orders.

id
string<uuid>
required
read-only

Unique identifier of this resource. Returned by the server; not writable.

user
object
required

User for this consultation. Returned by the server; not writable.

doctor
required

Assigned doctor, or null before assignment.

plan
enum<string>
required

Plan for this consultation. Returned by the server; not writable.

Available options:
one_off,
subscription
supply_days
integer | null
required
read-only

Supply days for this consultation. Returned by the server; not writable. May be null when unavailable.

questionnaire_submission
required

Questionnaire submission for this consultation. Returned by the server; not writable.

prescriptions
object[]
required
read-only

Prescriptions for this consultation. Returned by the server; not writable.

payments
object[]
required
read-only

Payments for this consultation. Returned by the server; not writable.

images
object[]
required
read-only

Images for this consultation. Returned by the server; not writable.

created_at
string<date-time>
required
read-only

Created at timestamp in ISO 8601 format. Returned by the server; not writable.

updated_at
string<date-time>
required
read-only

Updated at timestamp in ISO 8601 format. Returned by the server; not writable.

shopify_order_id
integer | null

Identifier of the related order. May be null when unavailable.

status
enum<string>

Status for this consultation.

Available options:
pending,
approved,
rejected
origin
enum<string>

Origin for this consultation.

Available options:
legacy_docalo,
checkout,
subscription_initial,
subscription_included,
subscription_renewal
patient_choice_status

Patient choice status for this consultation.

Available options:
awaiting,
confirmed,
waived
patient_choice_requested_at
string<date-time> | null

Patient choice requested at timestamp in ISO 8601 format. May be null when unavailable.

patient_choice_confirmed_at
string<date-time> | null

Patient choice confirmed at timestamp in ISO 8601 format. May be null when unavailable.

decision_reason
string | null

Decision reason for this consultation. May be null when unavailable.

treatment_id
string | null

Identifier of the related treatment. May be null when unavailable. Maximum 255 characters.

Maximum string length: 255
dosage
string | null

Dosage for this consultation. May be null when unavailable. Maximum 255 characters.

Maximum string length: 255
form_snapshot
object[] | null

Form snapshot for this consultation. May be null when unavailable.

decided_at
string<date-time> | null

Decided at timestamp in ISO 8601 format. May be null when unavailable.

brand
object

Clinical brand associated with the patient.

renewal_changed
boolean | null
read-only

Whether the patient reported changed renewal answers; null before a choice.

renewal_questionnaire_required
boolean
read-only

Whether this pending renewal needs a patient questionnaire.