FailedCheckins
Search FailedCheckins
Search and list FailedCheckin records with filtering, sorting, and pagination.
GET
A FailedCheckin records an unsuccessful check-in attempt by a coworker (see
Checkin entity). Each record captures the coworker involved, the location where the attempt occurred, the reason for the failure, and contextual details such as the coworker’s teams and tariff at the time.
Failed check-ins are read-only and generated automatically by the system when a check-in is rejected — for example, due to access restrictions, an inactive plan, or an unrecognised device. Use the Description field to inspect the specific failure reason.
The Source field indicates how the check-in was initiated (e.g. manual, Wi-Fi, app) and matches the eCheckinSource enum used by the Checkin entity.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the FailedCheckin-List role.Enums
eCheckinSource — Source values
eCheckinSource — Source values
| Value | Name |
|---|---|
| 0 | None |
| 1 | Manual |
| 2 | DoorAccess |
| 3 | NetworkActivity |
| 4 | Tile |
| 5 | Sensor |
Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by Coworker Id.
Filter by full name of the coworker at the time of the failed check-in.
Filter by Business Id.
Filter by name of the location where the check-in was attempted.
Filter by date and time when the check-in attempt occurred.
Filter by method used to initiate the check-in attempt (e.g. manual, Wi-Fi, app).
Filter by mAC addresses of the device used during the check-in attempt, if available.
Filter by comma-separated list of teams the coworker belonged to at the time of the failed check-in.
Filter by name of the pricing plan (tariff) assigned to the coworker at the time of the failed check-in.
Filter by reason or explanation for why the check-in attempt failed.
Filter by Checkin Attempt Time Local.
Range Filters
Filter by date and time when the check-in attempt occurred greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date and time when the check-in attempt occurred less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by checkin attempt time local greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by checkin attempt time local less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by CreatedOn
Range filters
Response
200
The list of FailedCheckin records matching the query. See the Get one FailedCheckin endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response