Skip to main content

Doctors

Retrieve a list of doctors in your organisation and view their prescription statistics over a given time period.

List Doctors

GET /v1/management/doctors
page
integer
default:"0"
Page number (0-indexed)
limit
integer
default:"50"
Number of doctors per page
Required permission: doctor:read

Example Request

curl -X GET "https://api.rxscale.com/v1/management/doctors?page=0&limit=25" \
  -H "X-API-Key: your-api-key-here"

Response

{
  "doctors": [
    {
      "uid": "doc-abc123",
      "display_name": "Dr. Schmidt"
    },
    {
      "uid": "doc-def456",
      "display_name": "Dr. Meier"
    }
  ],
  "total": 15,
  "totalPages": 1
}

Get Doctor Statistics

Retrieve prescription statistics for a specific doctor over a time period.
GET /v1/management/doctors/{doctor_uid}/statistics
doctor_uid
string
required
The doctor UID
from
integer
required
Start of time period (Unix timestamp in seconds)
to
integer
required
End of time period (Unix timestamp in seconds)
Required permission: doctor_statistics:read

Example Request

curl -X GET "https://api.rxscale.com/v1/management/doctors/doc-abc123/statistics?from=1709251200&to=1711929600" \
  -H "X-API-Key: your-api-key-here"

Response

{
  "uid": "doc-abc123",
  "display_name": "Dr. Schmidt",
  "prescription_statistics": {
    "signed": 42,
    "waiting_for_doctor": 3,
    "rejected": 1
  }
}

Response Fields

FieldTypeDescription
uidstringDoctor UID
display_namestringDoctor display name
prescription_statisticsobjectPrescription counts grouped by status

Error Responses

Status CodeDescription
400Missing or invalid from / to parameters
404Doctor not found or belongs to another organisation