List furlough balance mutations

GEThttps://<your-url>/api/v2/furlough-balance-mutations

MCP id furlough-balance-mutations.indexAlso on this path: POST Create a furlough balance mutation

Returns furlough balance mutations, an employee's own leave history by default, newest first.

Token scope: api:read:furlough
Without it: 403 insufficient-token-scope.
Permission: None. The record's own rules still apply.
Rate cost: 1 unit, read bucket. view=detail makes it 3. Adds: with_total=1 +2, 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 pending approval queue across the organisation

curl -G \
  'https://<your-url>/api/v2/furlough-balance-mutations' \
  --data-urlencode 'filter[is_approved][null]=true' \
  --data-urlencode 'sort=start' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/furlough-balance-mutations?filter[is_approved][null]=true&sort=start', {
  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/furlough-balance-mutations?filter[is_approved][null]=true&sort=start');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/furlough-balance-mutations?filter[is_approved][null]=true&sort=start',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "acceptor_id": 1,
      "year": 2026,
      "type": "regular",
      "minutes": -960,
      "start": "2026-07-06T00:00:00Z",
      "end": "2026-07-07T23:59:59Z",
      "description": "Long weekend",
      "is_approved": false,
      "user": {
        "id": 1
      },
      "created_at": "2026-03-04T09:15:00Z",
      "updated_at": "2026-03-04T09:15:00Z",
      "links": {
        "…": "1 field of FurloughBalanceMutationLinks"
      }
    }
  ],
  "meta": {
    "page": {
      "per_page": 1,
      "next_cursor": "…",
      "prev_cursor": "…",
      "total": 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"
  }
}

This one endpoint covers three lists in plnnrly: a year of one employee's history is filter[user_id]=me&filter[year]=2026, the manager's approval queue is filter[is_approved][null]=true, and a per-employee drill-down is filter[user_id]=N. The furlough prefix has no read permission, so what you see depends on your permissions alone: a caller sees only their own mutations unless they hold furlough::view_all or furlough::manage, and pointing filter[user_id] at another employee requires one of those two permissions.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

31 parameters in 6 groups

Views

viewstring

Which field set to render.

summarydefaultdetail

Pagination

Cursor pagination only. Follow links.next.

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.

with_totalboolean

Whether meta.page.total is counted for this request.

Default: false

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
[ne]: not equal

filter[acceptor_id]integer=[in][null]

The user who approved the mutation. null selects the mutations no one has approved: the pending ones and the denied ones alike.

A comma-separated list of at most 100 values.

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]

End of the period the mutation covers, in UTC.

filter[is_approved]boolean=[null]

Approval state. true selects the approved mutations, false the denied ones, and filter[is_approved][null]=true the ones still pending approval, which is the approval queue.

Whether the field is null.

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

Start of the period the mutation covers, in UTC.

filter[type]string=[ne][in]

Which leave balance the mutation moves.

A comma-separated list of at most 100 values.

regularspecial

New values may be added.

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

Last-write timestamp. Use for incremental sync.

filter[user_id]integer=[in]

Whose mutations to return. Accepts the literal me. Naming another user requires the furlough::view_all or furlough::manage permission, the same two that show the whole organisation's mutations.

A comma-separated list of at most 100 values.

filter[year]integer=[in]

The balance year the mutation counts against. Every balance sum counts by this year, so it is the right way to narrow a balance history to one year, rather than a range over start.

A comma-separated list of at most 100 values.

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: created_at

Key	Sorts by
`created_at`	When the mutation was filed, newest first.
`start`	Start of the period the mutation covers.
`end`	End of the period the mutation covers.
`year`	The balance year the mutation counts against.
`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
`user`	The employee this mutation belongs to.	+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 FurloughBalanceMutationList rows.

dataarray of FurloughBalanceMutationList

The rows, each a FurloughBalanceMutationList.

meta.pagePageOptionalTotal

per_page, next_cursor, prev_cursor, total.

linksPageLinks

self, next, prev.

Each row is a FurloughBalanceMutationList: 14 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

idinteger

Unique identifier.

user_idintegerServer-assigned

The employee this mutation belongs to. Always the authenticated user on create and not writable.

acceptor_idinteger or nullServer-assigned

The user who approved this mutation, set by the server when the mutation resolves to approved. Null while it is pending, and left null by a denial. Resolve the name through GET /api/v2/users/{user}.

yearinteger

The balance year this mutation counts against. It is not derived from start: every balance sum counts by this year, so a mutation whose period moves into another year keeps counting against the year sent here until year is sent too.

typestring

Which leave balance this mutation moves. Regular and special leave are separate balances and never offset one another.

regularspecial

New values may be added.

minutesinteger

The signed balance delta in minutes. Negative consumes balance (a leave request); positive grants it (a manager's adjustment, which requires the furlough::manage permission to write). The API never computes this from the employee's working week or the organisation's free days: send the exact number of minutes you mean.

starttimestamp (YYYY-MM-DDThh:mm:ssZ)

Start of the period this mutation covers, in UTC. Equal to end on a manual balance adjustment, which covers no period at all.

endtimestamp (YYYY-MM-DDThh:mm:ssZ)

End of the period this mutation covers, in UTC. Never before start, and equal to it on a manual balance adjustment.

descriptionstringMultiline

The employee's or manager's own words for this mutation: the reason for the leave, or what the adjustment is for. The only field ?q= searches.

is_approvedboolean or null

Approval state, in three values: null means pending approval, true approved, false denied. The balance counts pending and approved mutations alike and ignores denied ones. Writing this field at all requires the furlough::manage permission.

userRef or UserSummary

The employee this mutation belongs to. Expanding it with ?include=user additionally requires the users::read permission and a token scope covering the users prefix.