Server-side APIEndpointsLocations & configuration

Practitioners

The practitioners in your workspace, and the medos user ids you need for attribution.

GET /v1/doctors

This is also where you get the medos user ids you send as X-Acting-User-Id on every write.

API-key only (a widget session is refused) and entitlement-gated on devapi_catalog_doctors.

Query parameters

NameRequiredDescription
addressIdNoA clinic location, from GET /v1/addresses.

Try it

GET/v1/doctorsAPI key onlydevapi_catalog_doctors

The source of the medos user ids you send as X-Acting-User-Id.

Query

Request
GET /v1/doctors
to https://api.medos.one
Use 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/doctors" \
  -H "x-api-key: $MEDOS_API_KEY"

Common failures

StatusCause
403 with requiredFeatureNot entitled to this operation.
403 "only available to Developer API keys"A widget session token was used. Send x-api-key.

On this page