Skip to main content
GET
/
api
/
v1
/
profiles
/
{profile_id}
/
primary_appointments
Get profile's primary appointments
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/profiles/{profile_id}/primary_appointments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {
        "title": "<string>",
        "effective_from": "2023-12-25",
        "effective_to": "2023-12-25",
        "appointment_type": "<string>",
        "track_type": "<string>",
        "external_id": "<string>",
        "full_time": true,
        "percent_allocation": 123,
        "terminated_on": "2023-12-25",
        "termination_note": "<string>",
        "custom_fields": {}
      },
      "relationships": {
        "profile": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "department": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "rank": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        }
      }
    }
  ],
  "meta": {
    "total": 123,
    "page": {
      "size": 123
    }
  },
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<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

profile_id
string
required

Profile UUID

Query Parameters

page[size]
integer

Number of items per page

page[after]
string

Cursor for next page

page[before]
string

Cursor for previous page

Response

primary appointments found

data
object[]
required
meta
object
I