Skip to main content

Management API

The Management API provides organisation-level access to orders, prescriptions, products, doctors, patients, waiting room, listing requests, wallet passes, and webhook subscriptions. It is designed for back-office integrations and internal tooling.

Base Path

Interactive API Documentation (Swagger)

A live Swagger UI is available for exploring and testing endpoints directly in your browser:
The Swagger UI lets you try out API calls interactively. Authenticate with your API key to test against real data.

Authentication

Every endpoint accepts either an API key via the X-API-Key header, or an Auth0-issued OAuth Bearer token via the Authorization header. Both are scoped to an organisation and can access data for all entities within that organisation. See Authentication for how to obtain either credential and the audience a Bearer token must be issued for.
You can also connect an AI client (Cursor, Claude Desktop, …) directly to this API over MCP, using RxScale’s provided Auth0 application — no API key required in the client config. See the Management API MCP guide.

Available Endpoints

Required Permissions

Webhook subscription endpoints (notification-subscriptions) do not require a specific permission beyond a valid Management API key.