Skip to main content
GET
/
api
/
v1
/
profiles
/
{profile_id}
/
leaves
List leaves for a profile
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/profiles/{profile_id}/leaves \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "leave",
      "attributes": {
        "created_at": "<string>",
        "updated_at": "<string>",
        "custom_fields": {},
        "name": "<string>",
        "external_id": "<string>",
        "leave_type": "<string>",
        "effective_from": "2023-12-25",
        "effective_to": "2023-12-25",
        "fte_percentage": 123,
        "note": "<string>"
      },
      "relationships": {
        "profile": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "profile",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    }
  ],
  "meta": {
    "page": {
      "size": 123
    },
    "total": 123
  },
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "prev": "<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

Query Parameters

​
include
string

Comma-separated list of relationships to include. Allowed: profile

​
sort
string

Sort order. Prefix with - for descending. Allowed: created_at, updated_at

​
filter[key]
string

Filter results. Available filters: leave_type, name, name.neq, name.cont (case-insensitive substring match), name.in (comma-separated list), name.nin (comma-separated list), external_id, external_id.neq, external_id.cont (case-insensitive substring match), external_id.in (comma-separated list), external_id.nin (comma-separated list), effective_from, effective_from.neq, effective_from.lt, effective_from.lte, effective_from.gt, effective_from.gte, effective_to, effective_to.neq, effective_to.lt, effective_to.lte, effective_to.gt, effective_to.gte, fte_percentage (number), fte_percentage.neq (number), fte_percentage.lt (number), fte_percentage.lte (number), fte_percentage.gt (number), fte_percentage.gte (number), fte_percentage.in (number, comma-separated list), fte_percentage.nin (number, comma-separated list), profile. Custom fields can also be filtered with filter[custom_fields.field_name].

​
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

leaves found

​
data
object[]
required
​
meta
object
​
links
object