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

integer

default:"0"

Page number (0-indexed)

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

string

required

The doctor UID

integer

required

Start of time period (Unix timestamp in seconds)

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

Field	Type	Description
`uid`	string	Doctor UID
`display_name`	string	Doctor display name
`prescription_statistics`	object	Prescription counts grouped by status

Error Responses

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

Doctor SKU Blacklist

A doctor can be blocked from prescribing individual SKUs. A blacklisted SKU is excluded from that doctor’s prescribing options; every other doctor in the organisation is unaffected. All three endpoints resolve the doctor within the organisation that owns the API key. A doctor UID from another organisation is treated as not found.

List Blacklisted SKUs

GET /v1/management/doctors/{doctor_uid}/blacklisted-skus

Returns a paginated list of the SKUs this doctor may not prescribe. Required permission: doctor_blacklist:read

string

required

The doctor UID

integer

default:"0"

Page number (0-indexed)

integer

default:"50"

Number of SKUs per page. Capped at 200.

string

Case-insensitive substring filter. Matches the SKU display name, the product display name, or the PZN.

Example Request

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

Response

This endpoint returns its rows under blacklisted_skus, not under data like the other paginated endpoints. totalRegistries and totalPages behave as described in Pagination.

{
  "doctor_uid": "doc-abc123",
  "blacklisted_skus": [
    {
      "uid": "sku-abc123",
      "display_name": "Example SKU 10g",
      "product_uid": "prod-abc123",
      "product_display_name": "Example Product",
      "pzn": "12345678"
    }
  ],
  "totalRegistries": 1,
  "totalPages": 1
}

Response Fields

Field	Type	Description
`doctor_uid`	string	The doctor the blacklist belongs to
`blacklisted_skus[].uid`	string	SKU UID
`blacklisted_skus[].display_name`	string	SKU display name
`blacklisted_skus[].product_uid`	string	UID of the product the SKU belongs to
`blacklisted_skus[].product_display_name`	string \| null	Product display name, or `null` if the SKU has no product
`blacklisted_skus[].pzn`	string \| null	Pharmazentralnummer, if set
`totalRegistries`	integer	Total number of blacklisted SKUs matching the filter
`totalPages`	integer	Total number of pages

Error Responses

Status Code	Description
`403`	Missing `doctor_blacklist:read` permission
`404`	Doctor not found or belongs to another organisation

Blacklist a SKU

POST /v1/management/doctors/{doctor_uid}/blacklisted-skus

Blocks one SKU for this doctor. Required permission: doctor_blacklist:write

string

required

The doctor UID

string

required

UID of the SKU to blacklist. The SKU must belong to the same organisation.

Example Request

curl -X POST "https://api.rxscale.com/v1/management/doctors/doc-abc123/blacklisted-skus" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "sku_uid": "sku-abc123"
  }'

Response (201)

{
  "doctor_uid": "doc-abc123",
  "sku_uid": "sku-abc123"
}

Error Responses

Status Code	Description
`400`	Missing `sku_uid` in the request body
`403`	Missing `doctor_blacklist:write` permission
`404`	Doctor or SKU not found, or belongs to another organisation
`409`	This SKU is already blacklisted for this doctor

The 409 body names both UIDs:

{
  "error": "SKU sku-abc123 is already blacklisted for doctor doc-abc123"
}

Remove a SKU from the Blacklist

DELETE /v1/management/doctors/{doctor_uid}/blacklisted-skus/{sku_uid}

Allows this doctor to prescribe the SKU again. Required permission: doctor_blacklist:write

string

required

The doctor UID

string

required

UID of the SKU to remove from the blacklist

Example Request

curl -X DELETE "https://api.rxscale.com/v1/management/doctors/doc-abc123/blacklisted-skus/sku-abc123" \
  -H "X-API-Key: your-api-key-here"

Response

204 No Content with an empty body.

Error Responses

Status Code	Description
`403`	Missing `doctor_blacklist:write` permission
`404`	Doctor not found, or this SKU is not on the doctor’s blacklist

Getting Started

External Pharmacy API

Management API

Scheduling API

Public API

Patient API

Anamnesis API

Webhooks

Guides

Doctors

Doctors

List Doctors

Example Request

Response

Get Doctor Statistics

Example Request

Response

Response Fields

Error Responses

Doctor SKU Blacklist

List Blacklisted SKUs

Example Request

Response

Response Fields

Error Responses

Blacklist a SKU

Example Request

Response (201)

Error Responses

Remove a SKU from the Blacklist

Example Request

Response

Error Responses

​Doctors

​List Doctors

​Example Request

​Response

​Get Doctor Statistics

​Example Request

​Response

​Response Fields

​Error Responses

​Doctor SKU Blacklist

​List Blacklisted SKUs

​Example Request

​Response

​Response Fields

​Error Responses

​Blacklist a SKU

​Example Request

​Response (201)

​Error Responses

​Remove a SKU from the Blacklist

​Example Request

​Response

​Error Responses

Doctors

List Doctors

Example Request

Response

Get Doctor Statistics

Example Request

Response

Response Fields

Error Responses

Doctor SKU Blacklist

List Blacklisted SKUs

Example Request

Response

Response Fields

Error Responses

Blacklist a SKU

Example Request

Response (201)

Error Responses

Remove a SKU from the Blacklist

Example Request

Response

Error Responses