curl --request POST \
--url https://pria.praxislxp.com/api/user/availableInstitutions \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"search": "Biology",
"page": 2,
"pageSize": 25
}
'import requests
url = "https://pria.praxislxp.com/api/user/availableInstitutions"
payload = {
"search": "Biology",
"page": 2,
"pageSize": 25
}
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({search: 'Biology', page: 2, pageSize: 25})
};
fetch('https://pria.praxislxp.com/api/user/availableInstitutions', 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/availableInstitutions",
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([
'search' => 'Biology',
'page' => 2,
'pageSize' => 25
]),
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/availableInstitutions"
payload := strings.NewReader("{\n \"search\": \"Biology\",\n \"page\": 2,\n \"pageSize\": 25\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/availableInstitutions")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"search\": \"Biology\",\n \"page\": 2,\n \"pageSize\": 25\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/user/availableInstitutions")
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 \"search\": \"Biology\",\n \"page\": 2,\n \"pageSize\": 25\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"entitlements": [
{
"_id": "<string>",
"user": "<string>",
"institution": "<string>",
"accountType": "<string>",
"institution_data": {
"_id": "<string>",
"name": "<string>",
"ainame": "<string>",
"status": "<string>",
"credits": 123,
"poolCredits": true,
"rtEnabled": true,
"rtAdminOnly": true,
"rtVoice": "<string>",
"contactEmail": "<string>",
"picture": "<string>",
"picture_animated": "<string>",
"css": "<string>",
"about": "<string>",
"questionType": "<string>",
"allowJoining": "disabled",
"joiningAdminOnly": true
},
"account_data": {
"_id": "<string>",
"name": "<string>",
"managerEmail": "<string>",
"status": "<string>"
},
"entitlements": [
{}
]
}
],
"totalAvailable": 42,
"page": 2,
"pageSize": 25,
"totalMatching": 31,
"hasMore": true
}{
"success": false,
"message": "Error getting institutions <error details>",
"error": {}
}{
"success": false,
"message": "Authentication Required"
}Get available institutions
Retrieves a list of institutions the user can join. Results are wrapped in a UserInstitution-like structure with nested institution_data and account_data. Visibility rules depend on user account type and allowJoining/account settings. Optionally filters by a search term (matched against name, ainame, or account name). Optionally paged: when page and/or pageSize is present the rows are sorted by ainame, name, _id and only the requested page is returned, together with page/pageSize/totalMatching/hasMore. When neither is present every row is returned, unsorted, exactly as before.
curl --request POST \
--url https://pria.praxislxp.com/api/user/availableInstitutions \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"search": "Biology",
"page": 2,
"pageSize": 25
}
'import requests
url = "https://pria.praxislxp.com/api/user/availableInstitutions"
payload = {
"search": "Biology",
"page": 2,
"pageSize": 25
}
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({search: 'Biology', page: 2, pageSize: 25})
};
fetch('https://pria.praxislxp.com/api/user/availableInstitutions', 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/availableInstitutions",
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([
'search' => 'Biology',
'page' => 2,
'pageSize' => 25
]),
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/availableInstitutions"
payload := strings.NewReader("{\n \"search\": \"Biology\",\n \"page\": 2,\n \"pageSize\": 25\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/availableInstitutions")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"search\": \"Biology\",\n \"page\": 2,\n \"pageSize\": 25\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/user/availableInstitutions")
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 \"search\": \"Biology\",\n \"page\": 2,\n \"pageSize\": 25\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"entitlements": [
{
"_id": "<string>",
"user": "<string>",
"institution": "<string>",
"accountType": "<string>",
"institution_data": {
"_id": "<string>",
"name": "<string>",
"ainame": "<string>",
"status": "<string>",
"credits": 123,
"poolCredits": true,
"rtEnabled": true,
"rtAdminOnly": true,
"rtVoice": "<string>",
"contactEmail": "<string>",
"picture": "<string>",
"picture_animated": "<string>",
"css": "<string>",
"about": "<string>",
"questionType": "<string>",
"allowJoining": "disabled",
"joiningAdminOnly": true
},
"account_data": {
"_id": "<string>",
"name": "<string>",
"managerEmail": "<string>",
"status": "<string>"
},
"entitlements": [
{}
]
}
],
"totalAvailable": 42,
"page": 2,
"pageSize": 25,
"totalMatching": 31,
"hasMore": true
}{
"success": false,
"message": "Error getting institutions <error details>",
"error": {}
}{
"success": false,
"message": "Authentication Required"
}Authorizations
JWT token passed in x-access-token header
Body
Optional search term to filter institutions by name, ainame, or account name (case-insensitive)
"Biology"
Optional 1-based page number. Its presence (or pageSize's) switches the response to paged mode. Non-numeric or < 1 is treated as 1.
x >= 12
Optional rows per page, clamped to 1..100. Non-numeric falls back to 25. Its presence (or page's) switches the response to paged mode.
1 <= x <= 10025
Response
Available institutions retrieved successfully
true
Show child attributes
Show child attributes
Total number of available institutions before search filtering
42
Paged mode only — the 1-based page that was served (after coercion).
2
Paged mode only — the effective rows-per-page (after clamping/defaulting).
25
Paged mode only — number of rows matching the search filter across all pages (totalAvailable stays pre-search).
31
Paged mode only — true when page * pageSize < totalMatching, i.e. a further page exists.
true
Was this page helpful?