Read the organisation settings

Any signed in user. Returns the organisation identity, receipt, tax, and server address. A pharmacy that never saved settings still gets a full row filled with shipped defaults.

GET/api/v1/settings

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Responses

200

The organisation settings

idstringrequired

namestringrequired

legal_namestringrequired

logo_keystringrequired

logo_urlstringrequired

phonestringrequired

emailstringrequired

addressstringrequired

tinstringrequired

vat_numberstringrequired

nda_license_nostringrequired

premise_nostringrequired

receipt_headerstringrequired

receipt_footerstringrequired

return_policystringrequired

show_vat_breakdownbooleanrequired

show_pharmacist_on_receiptbooleanrequired

default_low_stock_thresholdintegerrequired

min -9007199254740991 · max 9007199254740991

expiry_warning_daysstringrequired

auto_print_receiptbooleanrequired

default_copiesintegerrequired

min -9007199254740991 · max 9007199254740991

tax_enabledbooleanrequired

tax_ratenumberrequired

base_currencystringrequired

rate_staleness_daysintegerrequired

min -9007199254740991 · max 9007199254740991

server_modestringrequired

Allowed:hostedcustom

server_urlstringrequired

updated_bystring | nullrequired

updated_atstring | nullrequired

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

Request

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

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

import requests

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

Response

{
  "id": "string",
  "name": "string",
  "legal_name": "string",
  "logo_key": "string",
  "logo_url": "string",
  "phone": "string",
  "email": "string",
  "address": "string",
  "tin": "string",
  "vat_number": "string",
  "nda_license_no": "string",
  "premise_no": "string",
  "receipt_header": "string",
  "receipt_footer": "string",
  "return_policy": "string",
  "show_vat_breakdown": true,
  "show_pharmacist_on_receipt": true,
  "default_low_stock_threshold": -9007199254740991,
  "expiry_warning_days": "string",
  "auto_print_receipt": true,
  "default_copies": -9007199254740991,
  "tax_enabled": true,
  "tax_rate": 0,
  "base_currency": "string",
  "rate_staleness_days": -9007199254740991,
  "server_mode": "hosted",
  "server_url": "string",
  "updated_by": "string",
  "updated_at": "string"
}

{
  "detail": "string"
}