Skip to content

Settings API

Base route: /api/settings
Auth required: ✅ JWT Bearer

Manages application-wide configuration key-value pairs.
Settings are pre-seeded via migrations — they can only be updated through the API, never created or deleted.


GET /api/settings

Returns all application settings.

Permission: Setting:Read

Response 200 OK

json
[
  {
    "key": "Currency",
    "value": "₹",
    "description": "Currency symbol displayed throughout the application"
  }
]

GET /api/settings/:key

Returns a single setting by its key.

Permission: Setting:Read

Example

GET /api/settings/Currency

Response 200 OK

json
{
  "key": "Currency",
  "value": "₹",
  "description": "Currency symbol displayed throughout the application"
}

Response 404 Not Found — Key does not exist


PUT /api/settings/:key

Updates the value of an existing setting. The key and description are immutable.

Permission: Setting:Update

Request Body

json
{
  "value": "$"
}

Response 200 OK — Updated AppSettingDto

Response 404 Not Found


Known Setting Keys

KeyDefault ValueDescription
CurrencyCurrency symbol displayed in amounts throughout the UI

MedRegia — Pharmaceutical Vendor Management Platform