List leaves for an institution

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

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "leave",
      "attributes": {
        "effective_from": "2023-12-25",
        "custom_fields": {},
        "name": "<string>",
        "external_id": "<string>",
        "leave_type": "<string>",
        "effective_to": "2023-12-25",
        "fte_percentage": 123,
        "note": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      },
      "relationships": {
        "profile": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "profile",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    }
  ]
}

GET

api

leaves

List leaves for an institution

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

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "leave",
      "attributes": {
        "effective_from": "2023-12-25",
        "custom_fields": {},
        "name": "<string>",
        "external_id": "<string>",
        "leave_type": "<string>",
        "effective_to": "2023-12-25",
        "fte_percentage": 123,
        "note": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      },
      "relationships": {
        "profile": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "profile",
            "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

sort

string

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

filter[name]

string

filter[name.neq]

string

filter[name.cont]

string

Case-insensitive substring match

filter[name.in]

string

Comma-separated list

filter[name.nin]

string

Comma-separated list

filter[external_id]

string

filter[external_id.neq]

string

filter[external_id.cont]

string

Case-insensitive substring match

filter[external_id.in]

string

Comma-separated list

filter[external_id.nin]

string

Comma-separated list

filter[leave_type]

string

filter[leave_type.neq]

string

filter[leave_type.cont]

string

Case-insensitive substring match

filter[leave_type.in]

string

Comma-separated list

filter[leave_type.nin]

string

Comma-separated list

filter[effective_from]

string