Skip to main content
POST
/
api
/
user
/
settingByKey
Retrieve settings by key
curl --request POST \
  --url https://pria.praxislxp.com/api/user/settingByKey \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "key": "variable-2",
  "status": "active",
  "institution": "6631915765bb0a94cfd6ca99"
}
'
{
  "success": true,
  "data": [
    {
      "_id": "687e6ee393c79717445848de",
      "key": "variable-2",
      "value": "variable value",
      "institution": "6631915765bb0a94cfd6ca99",
      "user": "6430d02554cd4e00403e8b05",
      "status": "active",
      "admin_only": true,
      "institution_shared": true,
      "editable_others": true,
      "created": "2023-11-07T05:31:56Z",
      "institution_data": {
        "_id": "6631915765bb0a94cfd6ca99",
        "name": "scarlet.hugo.praxis-ai.instructure.com",
        "ainame": "Scarlet"
      },
      "user_data": {
        "_id": "6430d02554cd4e00403e8b05",
        "email": "hugo.lebegue@gmail.com",
        "fname": "Hugo",
        "lname": "Lebegue"
      },
      "index": 1
    }
  ]
}

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[]