Queue status
Where the queue has reached: which token is being seen now.
GET /v1/qms-appointments/shift/statusThe live state of one shift. Use it to show a patient their position without re-reading the whole day.
API-key only (a widget session is refused) and entitlement-gated on devapi_qms_shift_status.
Query parameters
| Name | Required | Description |
|---|---|---|
addressId | No | A clinic location, from GET /v1/addresses. |
doctorId | No | A practitioner's medos user id, from GET /v1/doctors. |
qmsWorkShiftId | No | — |
sessionDate | No | YYYY-MM-DD |
Try it
/v1/qms-appointments/shift/statusAPI key onlydevapi_qms_shift_statusQuery
GET /v1/qms-appointments/shift/status?addressId=1&doctorId=4https://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 -sG "https://api.medos.one/v1/qms-appointments/shift/status" \
-H "x-api-key: $MEDOS_API_KEY" \
--data-urlencode "addressId=1" \
--data-urlencode "doctorId=4"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. |