curl --request GET \
--url https://api.scholarlysoftware.com/api/v1/institutions \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "institution",
"attributes": {
"name": "<string>",
"demo": true,
"created_at": "<string>",
"updated_at": "<string>"
},
"relationships": {
"profiles": {
"links": {
"related": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a/profiles",
"self": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a/relationships/profiles"
}
},
"departments": {
"links": {
"related": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a/departments",
"self": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a/relationships/departments"
}
},
"ranks": {
"links": {
"related": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a/ranks",
"self": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a/relationships/ranks"
}
}
},
"links": {
"self": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"meta": {
"profiles_count": 150,
"departments_count": 25,
"ranks_count": 5
}
}
]
}
Returns a list of institutions the authenticated user has access to
curl --request GET \
--url https://api.scholarlysoftware.com/api/v1/institutions \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "institution",
"attributes": {
"name": "<string>",
"demo": true,
"created_at": "<string>",
"updated_at": "<string>"
},
"relationships": {
"profiles": {
"links": {
"related": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a/profiles",
"self": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a/relationships/profiles"
}
},
"departments": {
"links": {
"related": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a/departments",
"self": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a/relationships/departments"
}
},
"ranks": {
"links": {
"related": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a/ranks",
"self": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a/relationships/ranks"
}
}
},
"links": {
"self": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"meta": {
"profiles_count": 150,
"departments_count": 25,
"ranks_count": 5
}
}
]
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Bearer token
institutions found
The response is of type object
.