API reference (preview)

Draft REST API reference. Endpoints may change before general availability.

Authentication

Send your API key as a bearer token. Keys are scoped to an organisation and a set of permissions.

bash

curl https://api.mediposiq.com/v1/organizations \
  -H "Authorization: Bearer $MEDIPOSIQ_API_KEY"

List endpoints return a meta.next_cursor. Pass it as cursor to fetch the next page.

Errors use standard HTTP status codes and a JSON body with code and message.

json

{
  "error": {
    "code": "invalid_metric",
    "message": "Unknown metric: bed_occ"
  }
}

Requests are rate limited per key. Responses include X-RateLimit-Remaining. Exceeding the limit returns 429.

Was this page helpful?