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"
}
'
import requests

url = "https://pria.praxislxp.com/api/user/settingByKey"

payload = {
"key": "variable-2",
"status": "active",
"institution": "6631915765bb0a94cfd6ca99"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({key: 'variable-2', status: 'active', institution: '6631915765bb0a94cfd6ca99'})
};

fetch('https://pria.praxislxp.com/api/user/settingByKey', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://pria.praxislxp.com/api/user/settingByKey",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'key' => 'variable-2',
'status' => 'active',
'institution' => '6631915765bb0a94cfd6ca99'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://pria.praxislxp.com/api/user/settingByKey"

payload := strings.NewReader("{\n \"key\": \"variable-2\",\n \"status\": \"active\",\n \"institution\": \"6631915765bb0a94cfd6ca99\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://pria.praxislxp.com/api/user/settingByKey")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"variable-2\",\n \"status\": \"active\",\n \"institution\": \"6631915765bb0a94cfd6ca99\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://pria.praxislxp.com/api/user/settingByKey")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"variable-2\",\n \"status\": \"active\",\n \"institution\": \"6631915765bb0a94cfd6ca99\"\n}"

response = http.request(request)
puts response.read_body
{
  "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
    }
  ]
}
{
"success": false,
"message": "Key is required!"
}
{
"success": false,
"message": "Authentication Required"
}

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