Skip to main content
POST
/
api
/
user
/
institutionByJoinId
Get institution by join code
curl --request POST \
  --url https://pria.praxislxp.com/api/user/institutionByJoinId \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "joinId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
'
{
  "success": true,
  "institution": {
    "_id": "<string>",
    "name": "<string>",
    "ainame": "<string>",
    "joinId": "<string>",
    "picture": "<string>",
    "picture_animated": "<string>",
    "picture_bg": "<string>",
    "picture_dark_bg": "<string>",
    "about": "<string>",
    "account": {
      "_id": "<string>",
      "name": "<string>"
    }
  }
}

Authorizations

​
x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
​
joinId
string
required

The institution's join code

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Institution found

​
success
boolean
Example:

true

​
institution
object