List free days

GEThttps://<your-url>/api/v2/free-days

MCP id free-days.indexAlso on this path: POST Create a free day

Returns the organisation's free days (the calendar dates on which it is closed, whether created from a recurring holiday or added by hand), newest first.

Token scope: api:read:free_days
Without it: 403 insufficient-token-scope.
Permission: free_days::manage
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket. view=detail makes it 3. Adds: each include +1, q +2.
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 free days in 2026, newest first

curl -G \
  'https://<your-url>/api/v2/free-days' \
  --data-urlencode 'filter[date][gte]=2026-01-01' \
  --data-urlencode 'filter[date][lte]=2026-12-31' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/free-days?filter[date][gte]=2026-01-01&filter[date][lte]=2026-12-31', {
  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/free-days?filter[date][gte]=2026-01-01&filter[date][lte]=2026-12-31');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/free-days?filter[date][gte]=2026-01-01&filter[date][lte]=2026-12-31',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": [
    {
      "id": 1,
      "description": "Office closed for the annual outing",
      "date": "2026-07-03",
      "holiday_id": 1,
      "holiday": null,
      "created_at": "2026-03-04T09:15:00Z",
      "updated_at": "2026-03-04T09:15:00Z",
      "links": {
        "…": "1 field of FreeDayLinks"
      }
    }
  ],
  "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"
  }
}

Free days are excluded from the working days a furlough request consumes. There is no year parameter: filter a year as filter[date][gte]=2026-01-01&filter[date][lte]=2026-12-31.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

19 parameters in 6 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[date]date (YYYY-MM-DD)=[gte][lte]

Calendar date the organisation is closed.

filter[holiday_id]integer=[in][null]

Recurring holiday the free day was instantiated from. null selects the manually added days.

A comma-separated list of at most 100 values.

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

Last-write timestamp. Use for incremental sync.

Search

qstring

Free-text search over description. At most one substring match per request: q together with a contains filter is 400 invalid-query-parameter.

Sorting

sortstring

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

Default: date

Key	Sorts by
`date`	Calendar date the organisation is closed, newest first.
`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
`holiday`	The recurring holiday this free day instantiates; absent for a manually added day.	+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 FreeDayList rows.

dataarray of FreeDayList

The rows, each a FreeDayList.

meta.pagePage

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

linksPageLinks

self, next, prev.

Each row is a FreeDayList: 8 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