# GET /api/v2/furlough-balance-mutations

List furlough balance mutations

- MCP id: furlough-balance-mutations.index
- Scope: api:read:furlough
- 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.
- Cache-Control: private, no-store

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

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.

## Parameters
- view (string, optional): Which field set to render.
- per_page (integer 1 to 100, optional): Rows per page. At most 25 when `include` names a to-many relation; a larger value is 400 invalid-query-parameter.
- cursor (string, optional): Opaque keyset cursor from a previous page's links.next. Never construct one by hand.
- with_total (boolean, optional): Whether meta.page.total is counted for this request.
- filter[acceptor_id] (integer, optional): The user who approved the mutation. `null` selects the mutations no one has approved: the pending ones and the denied ones alike. Operators: = in null.
- filter[created_at] (timestamp (YYYY-MM-DDThh:mm:ssZ), optional): Creation timestamp. Pair with `sort=id` for a stable full export. Operators: = gte lt.
- filter[end] (timestamp (YYYY-MM-DDThh:mm:ssZ), optional): End of the period the mutation covers, in UTC. Operators: = gte lte.
- filter[is_approved] (boolean, optional): 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. Operators: = null.
- filter[start] (timestamp (YYYY-MM-DDThh:mm:ssZ), optional): Start of the period the mutation covers, in UTC. Operators: = gte lte.
- filter[type] (string, optional): Which leave balance the mutation moves. Operators: = ne in.
- filter[updated_at] (timestamp (YYYY-MM-DDThh:mm:ssZ), optional): Last-write timestamp. Use for incremental sync. Operators: = gte lt.
- filter[user_id] (integer, optional): 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. Operators: = in.
- filter[year] (integer, optional): 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`. Operators: = in.
- q (string, optional): Free-text search over `description`. At most one substring match per request: `q` together with a `contains` filter is 400 invalid-query-parameter.
- sort (string, optional): Up to three keys, comma-separated, each optionally prefixed with `-` for descending.
- include (string, optional): Comma-separated names to inline, at most five.
- X-Request-Id (header, optional): 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-Match (header, optional): The ETag a read is conditional on. A match is answered 304 with no body.

## Response 200
- id (integer, required): Unique identifier.
- user_id (integer, required, server-assigned): The employee this mutation belongs to. Always the authenticated user on create and not writable.
- acceptor_id (integer or null, required, server-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}`.
- year (integer, required): 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.
- type (string, required): Which leave balance this mutation moves. Regular and special leave are separate balances and never offset one another.
- minutes (integer, required): 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.
- start (timestamp (YYYY-MM-DDThh:mm:ssZ), required): Start of the period this mutation covers, in UTC. Equal to `end` on a manual balance adjustment, which covers no period at all.
- end (timestamp (YYYY-MM-DDThh:mm:ssZ), required): End of the period this mutation covers, in UTC. Never before `start`, and equal to it on a manual balance adjustment.
- description (string, required, multiline): 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_approved (boolean or null, required): 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.
- user (Ref or UserSummary, required): 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.
- created_at (timestamp (YYYY-MM-DDThh:mm:ssZ), required): Creation timestamp.
- updated_at (timestamp (YYYY-MM-DDThh:mm:ssZ), required): Last-write timestamp; use for incremental sync.
- links (FurloughBalanceMutationLinks, required)
  - self (url, required): The canonical URI of this record.

## Errors
- 403 forbidden-by-policy | insufficient-permission | insufficient-token-scope: Forbidden.
- 304 : Not modified.
- 400 idempotency-key-required | invalid-cursor | invalid-query-parameter | malformed-request | unsupported-parameter: Bad request.
- 401 token-expired | unauthenticated: Unauthenticated.
- 404 endpoint-not-found | resource-not-found: Not found.
- 406 not-acceptable: Not acceptable.
- 429 rate-limit-exceeded: Too many requests.
- 500 internal-error: Server error.
- 503 tenant-unavailable: Service unavailable.

## Example
```bash
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'
```