Skip to main content
POST
Retrieve settings by key

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
key
string
required

Setting key to search for (exact match)

Example:

"variable-2"

status
enum<string>

Filter by status. When omitted, excludes settings with status 'deleted'.

Available options:
active,
inactive,
deleted
Example:

"active"

institution
string

Institution ID to scope the search. When omitted, returns settings where institution is null.

Example:

"6631915765bb0a94cfd6ca99"

Response

Successfully retrieved settings

success
boolean
Example:

true

data
object[]