Staff Check-Ins

Fetch staff check-ins

Returns a paginated list of staff check-in shifts, most recent first. Each shift spans a check-in and (once closed) a check-out; a shift whose check_out_at is null is still open (the user is currently checked in). Include ?include=event,notes to embed the linked booking and the shift's notes/photos.

search_mode chooses whose shifts you get:

  • my (default) — the authenticated user's own shifts. Requires own_staff_check_in_read_and_create.
  • all — every staff member's shifts in the franchise. Requires all_staff_check_in_read.
  • user — one staff member's shifts, named by staff_id (required). Requires all_staff_check_in_read.

Use all or user to sync timesheets to an external system. Shifts carry location and notes as well as times, so those modes are a wider grant than they may appear.

check_in_at_start and check_in_at_end bound the results by check-in date and are inclusive of both days. A shift is placed by when it started, so one running past midnight belongs to the day it began on.

The response includes meta.total_count and meta.per_page for pagination.

Available only when the franchise has staff check-in enabled.

get/api/v1/staff_check_ins

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/staff_check_ins
  • Auth: none declared. Required headers: Api-Key

Query parameters

search_modestring

Whose shifts to return. Defaults to my.:

  • my
  • all
  • user
staff_idinteger

The staff member whose shifts to return. Required when search_mode is user, ignored otherwise.

check_in_at_startstring

Only shifts that started on or after this date (inclusive)

check_in_at_endstring

Only shifts that started on or before this date (inclusive)

pageinteger

Page number for pagination (default: 1)

perinteger

Results per page (default: 25, max: 1000)

Headers

Api-Keystring required

Your Integration Key

Response

check-ins found

Changes

No recorded changes to this operation across all 2 revisions of this API.