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
/v1/management
Interactive API Documentation (Swagger)
A live Swagger UI is available for exploring and testing endpoints directly in your browser:https://api.rxscale.com/v1/management/apidocs
The Swagger UI lets you try out API calls interactively. Authenticate with your API key to test against real data.
Authentication
All endpoints require an API key via theX-API-Key header. Management API keys are scoped to an organisation and can access data for all entities within that organisation. See Authentication for details.
curl -X GET "https://api.rxscale.com/v1/management/health/" \
-H "X-API-Key: your-api-key-here"
Available Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /orders | List orders (paginated) |
GET | /orders/{order_uid} | View order details |
POST | /orders | Create an order from your own sales channel (Order Intake) |
POST | /orders/{external_id}/fulfillments | Add a new fulfillment to an existing order |
PATCH | /orders/{external_id} | Update item-free order fields |
POST | /orders/{external_id}/fulfillments/{fulfillment_external_id}/cancel | Cancel a fulfillment |
GET | /prescriptions/{prescription_uid} | View prescription details |
GET | /products | List products with SKUs (paginated) |
GET | /products/{product_uid} | View product details |
GET | /doctors | List doctors (paginated) |
GET | /doctors/{doctor_uid}/statistics | Get doctor prescription statistics |
GET | /doctors/{doctor_uid}/blacklisted-skus | List SKUs a doctor may not prescribe (paginated) |
POST | /doctors/{doctor_uid}/blacklisted-skus | Blacklist a SKU for a doctor |
DELETE | /doctors/{doctor_uid}/blacklisted-skus/{sku_uid} | Remove a SKU from a doctor’s blacklist |
GET | /patients?email=... | Search patient by email |
GET | /patients/{patient_uid} | View patient profile |
GET | /patients/{patient_uid}/intent/{intent} | Check patient intent |
POST | /waiting-room/register | Register patient for waiting room |
GET | /waiting-room/{queue_uid}/status | Check queue status |
DELETE | /waiting-room/{queue_uid} | Cancel queue registration |
POST | /review-links | Create a single-use review link for a pharmacy order |
GET | /review-links | List review links |
DELETE | /review-links/{uid} | Revoke a review link |
GET | /listing-requests | List listing requests (paginated) |
GET | /listing-requests/{uid} | View a listing request |
POST | /listing-requests/{uid}/accept | Accept a pending listing request |
POST | /listing-requests/{uid}/decline | Decline a pending listing request |
GET | /wallet-passes/templates | List wallet pass templates |
GET | /wallet-passes | List wallet passes |
POST | /wallet-passes | Issue a wallet pass for a patient |
GET | /wallet-passes/{wallet_pass_uid} | Get a single wallet pass |
DELETE | /wallet-passes/{wallet_pass_uid} | Revoke a wallet pass |
POST | /wallet-passes/verify | Verify a scanned wallet pass |
POST | /wallet-passes/push-notifications | Send push notifications |
GET | /notification-subscriptions | List webhook subscriptions |
POST | /notification-subscriptions | Register webhook subscription |
DELETE | /notification-subscriptions | Remove webhook subscription |
POST | /notification-subscriptions/test | Test webhook delivery |
GET | /scheduling/appointments | List scheduled appointments (paginated) |
POST | /scheduling/appointments/{meeting_uid}/cancel | Cancel a scheduled appointment |
GET | /scheduling/appointment-types | List appointment types |
POST | /scheduling/appointment-types | Create an appointment type |
PATCH | /scheduling/appointment-types/{uid} | Update an appointment type |
DELETE | /scheduling/appointment-types/{uid} | Delete an appointment type |
GET | /scheduling/appointment-types/{uid}/reminders | List appointment-type reminders |
POST | /scheduling/appointment-types/{uid}/reminders | Create an appointment-type reminder |
PATCH | /scheduling/appointment-types/{uid}/reminders/{reminder_uid} | Update a reminder |
DELETE | /scheduling/appointment-types/{uid}/reminders/{reminder_uid} | Delete a reminder |
GET | /scheduling/doctors/{doctor_uid}/availability-rules | List a doctor’s availability rules |
POST | /scheduling/doctors/{doctor_uid}/availability-rules | Create an availability rule |
PATCH | /scheduling/doctors/{doctor_uid}/availability-rules/{rule_uid} | Update an availability rule |
DELETE | /scheduling/doctors/{doctor_uid}/availability-rules/{rule_uid} | Delete an availability rule |
GET | /scheduling/doctors/{doctor_uid}/availability-date-overrides | List date overrides (paginated) |
POST | /scheduling/doctors/{doctor_uid}/availability-date-overrides | Create a date override |
PATCH | /scheduling/doctors/{doctor_uid}/availability-date-overrides/{override_uid} | Update a date override |
DELETE | /scheduling/doctors/{doctor_uid}/availability-date-overrides/{override_uid} | Delete a date override |
POST | /anamnesis/patient-connections | Connect an anamnesis submission to a patient |
Required Permissions
| Endpoint | Required Permission |
|---|---|
| View orders | order:read |
| Create/update/cancel orders (Order Intake) | order:write |
| View prescriptions | prescription:read |
| List products | product:read |
| List doctors | doctor:read |
| Doctor statistics | doctor_statistics:read |
| List a doctor’s blacklisted SKUs | doctor_blacklist:read |
| Blacklist / unblacklist a SKU for a doctor | doctor_blacklist:write |
| View patients | patient:read |
| Register / cancel waiting room | waiting_room:write |
| View waiting room status | waiting_room:read |
| Create / revoke review links | review_link:write |
| List review links | review_link:read |
| List wallet pass templates | wallet_pass_template:read |
| List / get wallet passes | wallet_pass:read |
| Issue / revoke a wallet pass | wallet_pass:write |
| Verify a scanned wallet pass | wallet_pass:verify |
| Send push notifications | wallet_pass_push_notification:write |
| List / view listing requests | listing_request:read |
| Accept / decline listing requests | listing_request:write |
Read scheduling data (all scheduling GET endpoints) | scheduling:read |
Change scheduling data (all scheduling POST / PATCH / DELETE endpoints) | scheduling:admin |
| Connect an anamnesis submission to a patient | anamnesis:connect_patient |
Webhook subscription endpoints (notification-subscriptions) do not require a specific permission beyond a valid Management API key.