List absences

GEThttps://<your-url>/api/v2/absences

MCP id absences.indexAlso on this path: POST Book an absence

Returns absences (the periods employees were away from work), newest first by start.

Token scope: api:read:absences
Without it: 403 insufficient-token-scope.
Permission: absences::manage
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket. view=detail makes it 3. Adds: each include +1.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: The absences that are still running

curl -G \
  'https://<your-url>/api/v2/absences' \
  --data-urlencode 'filter[end][null]=true' \
  --data-urlencode 'include=user' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/absences?filter[end][null]=true&include=user', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/absences?filter[end][null]=true&include=user');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/absences?filter[end][null]=true&include=user',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "user": {
        "id": 1
      },
      "manager_id": 1,
      "manager": null,
      "start": "2026-03-02T08:00:00Z",
      "end": "2026-03-06T17:00:00Z",
      "created_at": "2026-03-04T09:15:00Z",
      "updated_at": "2026-03-04T09:15:00Z",
      "links": {
        "…": "1 field of AbsenceLinks"
      }
    }
  ],
  "meta": {
    "page": {
      "per_page": 1,
      "next_cursor": "…",
      "prev_cursor": "…",
      "total": 1,
      "current_page": 1,
      "last_page": 1
    }
  },
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1",
    "next": "https://<your-url>/api/v2/work-items/1",
    "prev": "https://<your-url>/api/v2/work-items/1"
  }
}

An absence with a null end is still running. There is no year parameter and no ongoing parameter: filter a year as filter[start][gte]=2026-01-01T00:00:00Z&filter[start][lte]=2026-12-31T23:59:59Z, and the running absences as filter[end][null]=true. There is no q parameter either: an absence has no text of its own.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

24 parameters in 5 groups

Views

viewstring

Which field set to render.

summarydefaultdetail

Pagination

per_pageinteger1 to 100

Rows per page. At most 25 when include names a to-many relation; a larger value is 400 invalid-query-parameter.

Default: 25

cursorstring

Opaque keyset cursor from a previous page's links.next. Never construct one by hand.

pageinteger1 to 1000

Opt in to page-number paging: 1-based, at most 1000. Omit it, the default, to page by opaque cursor, which is what links.next hands you. Cannot be combined with cursor. Published only on collections that count their rows on every request.

Filters

=: equals
[in]: any of a comma-separated list
[null]: true or false: whether it is empty
[gte][lte][lt]: at least, at most, less than

filter[created_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Creation timestamp. Pair with sort=id for a stable full export.

filter[end]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lte][null]

When the absence ends. null selects the absences that are still running.

Whether the field is null.

filter[manager_id]integer=[in][null]

Manager who filed or approved the absence. null selects absences with no manager recorded.

A comma-separated list of at most 100 values.

filter[start]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lte]

When the absence begins.

filter[updated_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Last-write timestamp. Use for incremental sync.

filter[user_id]integer=[in]

Whose absence this is. Accepts the literal me. Naming another user requires the absences::manage permission.

A comma-separated list of at most 100 values.

Sorting

sortstring

Up to three keys, comma-separated, each optionally prefixed with - for descending.

Default: start

Key	Sorts by
`start`	When the absence begins, newest first.
`end`	When the absence ends.
`id`	Id, ascending. An id never changes, so use this for a stable full export.
`updated_at`	Last-write timestamp; pair with the id tiebreaker for sync.

Prefix a key with - for descending.

Includes

includestring

Comma-separated names to inline, at most five.

Path	Adds	Cost
`manager`	The manager who filed or approved the absence.	+1
`user`	The employee the absence is for.	+1

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a page of AbsenceList rows.

dataarray of AbsenceList

The rows, each a AbsenceList.

meta.pagePage

per_page, next_cursor, prev_cursor, total, current_page, last_page.

linksPageLinks

self, next, prev.

Each row is a AbsenceList: 10 fields.

Headers

ETag: A weak validator (W/"…") of the rendered page.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning