Read an appointment
One appointment by id, with its patient, practitioner, payment state and status history.
GET /v1/appointments/{appointmentId}Reads back an appointment by id, so your own system can reconcile against medos instead of assuming its writes stuck.
API-key only (a widget session is refused) and entitlement-gated on devapi_appointments_get.
Path parameters
| Name | Required | Description |
|---|---|---|
appointmentId | Yes | Fills the :appointmentId segment. |
Try it
/v1/appointments/:appointmentIdAPI key onlydevapi_appointments_getPath
GET /v1/appointments/https://api.medos.oneUse a dedicated test key, and put your browser's address on its allowlist
A Developer API key authenticates on its own, so it only works from the addresses registered against it — and this page calls from your browser, not your servers. Unless your own public address is on the list you get a 403 naming it, which is the allowlist doing its job. Your browser may also reach us over IPv6 even when your server does not, so the address in the error is often not the one you expected. The key here is kept in memory only and never written to storage, but create a test key for it and deactivate that key when you are done.
Request
curl -s "https://api.medos.one/v1/appointments/1024" \
-H "x-api-key: $MEDOS_API_KEY"Returns the full appointment with its patient, practitioner, location, payment state and status history — the same body the medos dashboard renders.
Common failures
| Status | Cause |
|---|---|
403 with requiredFeature | Not entitled to this operation. |
403 "only available to Developer API keys" | A widget session token was used. Send x-api-key. |
404 | No such appointment in your workspace. |