Skip to main content

​
Management API

The Management API gives you programmatic access to your organisation’s data in RxScale. This page provides an overview of what you can do with the API and common use cases.

​
Overview

The Management API is designed for telemedicine providers who need to:
  • Query and manage orders and prescriptions.
  • Manage their product catalog and SKUs.
  • Access doctor and patient information.
  • Set up waiting rooms for video consultations.
  • Create and manage wallet passes for patient verification.
  • Register and manage webhooks.
All API requests require authentication using an API key in the X-API-Key header.

​
Common Use Cases

​
Tracking Orders

Use the orders endpoints to:
  • List all orders for your organisation, with filters for status, date range, and more.
  • Get detailed information about a specific order, including its current status, associated prescription, and pharmacy assignment.
  • Monitor order progress alongside webhook notifications.

​
Managing Prescriptions

Use the prescriptions endpoints to:
  • View prescription details, including the doctor’s decision and signing status.
  • Track prescription status changes over time.

​
Product Management

Use the products endpoints to:
  • List your products and SKUs.
  • Update product information.
  • Manage pricing and availability.

​
Doctors and Patient Management

Use the doctors and patients endpoints to:
  • View which doctors are available in your organisation.
  • Access patient records and prescription history.
  • Manage patient data within your organisation.

​
Waiting Room

Use the waiting room endpoints to:
  • Register patients for video consultations.
  • Manage the consultation queue.
  • Connect patients with available doctors.
See Waiting Room for more details on this feature.

​
Wallet Passes

Use the wallet passes endpoints to:
  • Create digital wallet passes for patients.
  • Send push notifications to patients through their wallet pass.
  • Manage patient verification using QR codes.
See Wallet Passes for more details on this feature.

​
Getting Started with the API

1

Get your API key

Contact your RxScale account manager to receive your API credentials.
2

Choose your environment

Use the development environment for testing (https://api.rxscale-dev.com) and the production environment for live data (https://api.rxscale.com).
3

Make your first request

Try listing your orders to verify your API key is working:
curl -X GET "https://api.rxscale.com/v1/management-api-v1/orders" \
  -H "X-API-Key: your-api-key-here"
4

Explore the API reference

See the full API reference for all available endpoints, request formats, and response schemas.

​
Full API Reference

For complete documentation of all endpoints, request parameters, and response formats, see the Management API Reference.