Skip to main content
POST
/
api
/
user
/
availableInstitutions
Get available institutions
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"
}
'
{
  "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
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json

Optional search term to filter institutions by name, ainame, or account name (case-insensitive)

Example:

"Biology"

Response

Available institutions retrieved successfully

success
boolean
Example:

true

entitlements
object[]
totalAvailable
integer

Total number of available institutions before search filtering

Example:

42