List prescriptions

Any signed in user. Returns the caller’s branch prescriptions with their medicine lines. Pending first, status filters to PENDING, DISPENSED, or CANCELLED, and the page params page.

GET/api/v1/prescriptions

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Query parameters

statusstring

Filter to PENDING, DISPENSED, or CANCELLED. Any other value returns nothing.

pageinteger

Page number, 1 based. Defaults to 1.

page_sizeinteger

Rows per page, capped at 200. Defaults to 20.

Responses

200

A page of prescriptions

totalintegerrequired

min -9007199254740991 · max 9007199254740991

pageintegerrequired

min -9007199254740991 · max 9007199254740991

page_sizeintegerrequired

min -9007199254740991 · max 9007199254740991

itemsobject[]required

Show properties

Array of object

idstringrequired

branch_idstringrequired

rx_numberstringrequired

patient_namestringrequired

patient_id_numberstringrequired

prescriber_namestringrequired

prescriber_licensestringrequired

statusstringrequired

sale_idstring | nullrequired

dispensed_bystring | nullrequired

dispensed_by_namestring | nullrequired

notesstringrequired

created_bystringrequired

created_atstringrequired

updated_atstringrequired

dispensed_atstring | nullrequired

itemsobject[]required

Show properties

Array of object

idstringrequired

prescription_idstringrequired

medicine_idstringrequired

quantityintegerrequired

min -9007199254740991 · max 9007199254740991

dosage_instructionsstringrequired

medicine_namestringrequired

selling_pricestringrequired

vat_categorystringrequired

requires_prescriptionintegerrequired

min -9007199254740991 · max 9007199254740991

401

Not authenticated

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

statusqueryFilter to PENDING, DISPENSED, or CANCELLED. Any other value returns nothing.pagequeryPage number, 1 based. Defaults to 1.page_sizequeryRows per page, capped at 200. Defaults to 20.

Request

curl -X GET 'http://localhost:8000/api/v1/prescriptions' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/prescriptions", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/prescriptions",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "total": -9007199254740991,
  "page": -9007199254740991,
  "page_size": -9007199254740991,
  "items": [
    {
      "id": "string",
      "branch_id": "string",
      "rx_number": "string",
      "patient_name": "string",
      "patient_id_number": "string",
      "prescriber_name": "string",
      "prescriber_license": "string",
      "status": "string",
      "sale_id": "string",
      "dispensed_by": "string",
      "dispensed_by_name": "string",
      "notes": "string",
      "created_by": "string",
      "created_at": "string",
      "updated_at": "string",
      "dispensed_at": "string",
      "items": [
        {
          "id": "string",
          "prescription_id": "string",
          "medicine_id": "string",
          "quantity": -9007199254740991,
          "dosage_instructions": "string",
          "medicine_name": "string",
          "selling_price": "string",
          "vat_category": "string",
          "requires_prescription": -9007199254740991
        }
      ]
    }
  ]
}

{
  "detail": "string"
}