GET
/
api
/
v1
/
institutions
/
{institution_id}
/
ranks
List ranks for an institution
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/institutions/{institution_id}/ranks \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "rank",
      "attributes": {
        "name": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      },
      "relationships": {
        "institution": {
          "links": {
            "related": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      },
      "links": {
        "self": "/api/v1/ranks/7h8i9j0k-4567-8901-2345-def456789012"
      },
      "meta": {
        "deletable": true,
        "primary_appointments_count": 42
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

Bearer token

Path Parameters

institution_id
string
required

Institution UUID

Query Parameters

filter[name_cont]
string

Filter by name containing value

sort
string

Sort order (e.g., -created_at,name)

page[number]
integer

Page number

page[size]
integer

Page size

Response

200
application/vnd.api+json

ranks found

The response is of type object.