Staff Check-Ins

Record a check-in punch

Records a staff punch for the authenticated user. One endpoint drives all three actions via kind:

  • check_in — open a new shift. Fails if the user already has an open shift.
  • check_out — close the user's currently-open shift.
  • status_update — add a note and/or photo to the open shift (a note or attachment is required).

event_id optionally links the shift to a booking (there is no assignment gate — any staffer may check in to any event, or none). Location (latitude, longitude, location_accuracy) is best-effort — omit it and the punch still succeeds. Times are always server-stamped; any client-supplied time is ignored. note and attachments (ActiveStorage signed ids) may accompany a check-in or check-out too, and are stored as a note on the shift.

Available only when the franchise has staff check-in enabled, and only to staff/admin users.

post/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

Headers

Api-Keystring required

Your Integration Key

Request body

kind'check_in' | 'check_out' | 'status_update' required

The punch type

event_idinteger

Optional booking (Event) to link the shift to

latitudenumber

Best-effort latitude at the moment of the punch

longitudenumber

Best-effort longitude at the moment of the punch

location_accuracynumber

Best-effort location accuracy in meters

notestring

Optional note (required for status_update if no attachment)

attachmentsstring[]

ActiveStorage signed ids for photos/files

Response

checked in

Changes

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