Skip to main content
GET
List consult-first requests

Authorizations

Authorization
string
header
required

API key issued by VitaRelay. Send as Authorization: Bearer vr_live_… (production) or Authorization: Bearer vr_test_… (sandbox).

Query Parameters

patient_id
string<uuid>
status
enum<string>

awaiting_consult_payment the consult is not paid yet; awaiting_doctor the doctor network is reviewing; declined no prescription (final); awaiting_patient_checkout the doctor approved and the patient must approve the medication order; charging the card is being charged; charge_failed the card failed, the patient can try again; completed the medication order was placed and paid (final); cancelled (final).

Available options:
awaiting_consult_payment,
awaiting_doctor,
declined,
proposal_ready,
charging,
awaiting_patient_checkout,
completed,
charge_failed,
cancelled
limit
integer
Required range: 1 <= x <= 100
cursor
string

Response

The clinic's consult requests.

data
object[]
next_cursor
string | null