List primary appointments

curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/primary_appointments \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "primary_appointment",
      "attributes": {
        "title": "Associate Professor",
        "effective_from": "2025-01-01",
        "custom_fields": {},
        "track_type": "Research",
        "external_id": "EMP001234",
        "effective_to": "2026-01-01",
        "terminated_on": "2026-12-31",
        "termination_note": "Resigned to accept position elsewhere",
        "percent_allocation": 100,
        "full_time": true,
        "note": "<div>This is a note with <strong>formatting</strong></div>",
        "note_as_plain_text": "This is a note with formatting"
      },
      "relationships": {
        "profile": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "profile",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "rank": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "rank",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "department": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "department",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    }
  ]
}

GET

api

primary_appointments

List primary appointments

curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/primary_appointments \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "primary_appointment",
      "attributes": {
        "title": "Associate Professor",
        "effective_from": "2025-01-01",
        "custom_fields": {},
        "track_type": "Research",
        "external_id": "EMP001234",
        "effective_to": "2026-01-01",
        "terminated_on": "2026-12-31",
        "termination_note": "Resigned to accept position elsewhere",
        "percent_allocation": 100,
        "full_time": true,
        "note": "<div>This is a note with <strong>formatting</strong></div>",
        "note_as_plain_text": "This is a note with formatting"
      },
      "relationships": {
        "profile": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "profile",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "rank": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "rank",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "department": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "department",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    }
  ]
}

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

Query Parameters

page[size]

integer

Number of items per page (max 100)

page[after]

string

Cursor for next page

page[before]

string

Cursor for previous page

Response

primary appointments found

data

object[]

required

Show child attributes

data.id

string<uuid>

required

data.type

string

required

Allowed value: "primary_appointment"

Example:

"primary_appointment"

data.attributes

object

required

Show child attributes

data.attributes.title

string | null

required

Example:

"Associate Professor"

data.attributes.effective_from

string<date> | null

required

Example:

"2025-01-01"

data.attributes.custom_fields

object

data.attributes.track_type

string | null

Example:

"Research"

data.attributes.external_id

string | null

Example:

"EMP001234"

data.attributes.effective_to

string<date> | null

Example:

"2026-01-01"

data.attributes.terminated_on

string<date> | null

Example:

"2026-12-31"

data.attributes.termination_note

string | null

Example:

"Resigned to accept position elsewhere"

data.attributes.percent_allocation

number | null

Example:

100

data.attributes.full_time

boolean | null

data.attributes.note

string | null

Example:

"<div>This is a note with <strong>formatting</strong></div>"

data.attributes.note_as_plain_text

string | null

Example:

"This is a note with formatting"

data.relationships

object

Show child attributes

data.relationships.profile

object

required

Option 1
Option 2
Option 3

Show child attributes

data.relationships.profile.links

object

required

Show child attributes

data.relationships.profile.meta

object

data.relationships.profile.data

object

Show child attributes

data.relationships.profile.data.type

string

required

Allowed value: "profile"

Example:

"profile"

data.relationships.profile.data.id

string<uuid>

required

data.relationships.rank

object

required

Option 1
Option 2
Option 3

Show child attributes

data.relationships.rank.links

object

required

Show child attributes

data.relationships.rank.meta

object

data.relationships.rank.data

object

Show child attributes

data.relationships.rank.data.type

string

required

Allowed value: "rank"

Example:

"rank"

data.relationships.rank.data.id

string<uuid>

required

data.relationships.department

object

required

Option 1
Option 2
Option 3

Show child attributes

data.relationships.department.links

object

required

Show child attributes

data.relationships.department.meta

object

data.relationships.department.data

object

Show child attributes

data.relationships.department.data.type

string

required

Allowed value: "department"

Example:

"department"

data.relationships.department.data.id

string<uuid>

required

Update a phone number Create primary appointment

⌘I

API reference

Authorizations

Headers

Query Parameters

Response