Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

Partner API key sent as Authorization: Bearer . Test keys and live keys are separate.

Query Parameters

status
enum<string>

Only consultations in this status.

Available options:
approved,
cancelled,
in_review,
info_requested,
rejected,
submitted
external_patient_id
string

Only consultations for the patient with this external_patient_id from your system.

external_reference
string

Only the consultation with this external_reference from your system.

created_after
string<date-time>

Inclusive.

created_before
string<date-time>

Exclusive.

limit
integer
default:50

Page size, 1 to 100. Default 50. A value outside the range is refused with 400 invalid_request.

Required range: 1 <= x <= 100
cursor
string

The next_cursor of the previous page.

Response

Success.

object
enum<string>
required

The object type.

Available options:
list
results
object[]
required

The items on this page.

next_cursor
string | null
required

Cursor for the next page; null on the last page.