Skip to main content
POST
/
api
/
user
/
institutionByJoinId
Get institution by join code
curl --request POST \
  --url http://localhost:3000/api/user/institutionByJoinId \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "joinId": "abc123xyz"
}
'
{
  "success": true,
  "institution": {
    "_id": "<string>",
    "name": "<string>",
    "ainame": "<string>",
    "picture": "<string>",
    "allowJoining": "disabled"
  }
}

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:

"abc123xyz"

Response

Institution found

success
boolean
Example:

true

institution
object