GET
/
api
/
v1
/
institutions
/
{institution_id}
/
primary_appointments
List primary appointments
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/institutions/{institution_id}/primary_appointments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "289f7cdd-be9d-4ce1-8149-569c50ed85ff",
      "type": "primary_appointment",
      "attributes": {
        "title": "<string>",
        "effective_from": "2023-12-25",
        "effective_to": "2023-12-25",
        "appointment_type": "<string>",
        "full_time": true,
        "percent_allocation": 123,
        "terminated_on": "2023-12-25",
        "termination_note": "<string>",
        "track_type": "<string>",
        "external_id": "<string>"
      }
    }
  ]
}

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

page[size]
integer

Number of items per page

page[number]
integer

Page number

Response

200 - application/vnd.api+json

primary appointments found

The response is of type object.