# GET /api/v2/checkins

List checkins

- MCP id: checkins.index
- Scope: api:read:checkins
- Permission: checkins::read
- Rate cost: 1 unit, read bucket. `view=detail` makes it 3. Adds: `with_total=1` +2, each include +1.
- Cache-Control: private, no-store

Returns attendance records, one per clock-in, newest first.

Every operation on this resource requires `checkins::read`, which is the attendance report permission in plnnrly, and a holder sees the whole team; there is no own-rows view for a caller without it. `filter[checked_out_at][null]=true` returns the still-open checkins, which is the only way to ask who is currently clocked in. There is no `week` parameter: filter a week as `filter[checked_in_at][gte]=2026-08-31T00:00:00Z&filter[checked_in_at][lte]=2026-09-06T23:59:59Z`. `meta.page.total` is `null` unless you pass `with_total=1`. `?include=user` expands the employee reference and additionally requires the `users::read` permission and a token scope covering the users prefix; without either it is a `400`, never a `403`.

## 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[checked_in_at] (timestamp (YYYY-MM-DDThh:mm:ssZ), optional): When the employee clocked in. Operators: = gte lte.
- filter[checked_out_at] (timestamp (YYYY-MM-DDThh:mm:ssZ), optional): When the employee clocked out. `null` selects the still-open checkins. Operators: = gte lte 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[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 checkins to return. Accepts the literal `me`. Naming another employee requires the `checkins::read` permission. Operators: = in.
- 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): Employee this checkin belongs to. Assigned from the authenticated user on create and never writable.
- user (Ref or UserSummary, required): The employee this checkin belongs to. Expanding it with `?include=user` additionally requires the `users::read` permission and a token scope covering the users prefix.
- checked_in_at (timestamp (YYYY-MM-DDThh:mm:ssZ), required): When the employee clocked in.
- checked_out_at (timestamp (YYYY-MM-DDThh:mm:ssZ) or null, required): When the employee clocked out, or `null` while the checkin is still open. A `null` value marks the checkin plnnrly shows as active.
- 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 (CheckinLinks, 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/checkins' \
  --data-urlencode 'filter[checked_out_at][null]=true' \
  --data-urlencode 'include=user' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'
```