List checkins

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

MCP id checkins.indexAlso on this path: POST Check in

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

Token scope: api:read:checkins
Without it: 403 insufficient-token-scope.
Permission: checkins::read
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket. view=detail makes it 3. Adds: with_total=1 +2, 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: Who is currently clocked in

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'

const response = await fetch('https://<your-url>/api/v2/checkins?filter[checked_out_at][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/checkins?filter[checked_out_at][null]=true&include=user');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/checkins?filter[checked_out_at][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
      },
      "checked_in_at": "2026-03-04T09:15:00Z",
      "checked_out_at": "2026-03-04T09:15:00Z",
      "created_at": "2026-03-04T09:15:00Z",
      "updated_at": "2026-03-04T09:15:00Z",
      "links": {
        "…": "1 field of CheckinLinks"
      }
    }
  ],
  "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"
  }
}

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.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

21 parameters in 5 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

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

When the employee clocked in.

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

When the employee clocked out. null selects the still-open checkins.

Whether the field is null.

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

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

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

Last-write timestamp. Use for incremental sync.

filter[user_id]integer=[in]

Whose checkins to return. Accepts the literal me. Naming another employee requires the checkins::read 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: created_at

Key	Sorts by
`created_at`	When the checkin row was created, newest first.
`checked_in_at`	When the employee clocked in.
`checked_out_at`	When the employee clocked out; the still-open checkins sort with the nulls.
`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 checkin 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 CheckinList rows.

dataarray of CheckinList

The rows, each a CheckinList.

meta.pagePageOptionalTotal

per_page, next_cursor, prev_cursor, total.

linksPageLinks

self, next, prev.

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