Skip to main content

How to Get Check-Ins

This documentation goes over how to get check-ins for both employers and workspaces

Prerequisites

How check-ins work

How to get my tenant id

How To

Use the /checkin endpoint to get a list of cheeck-ins

  • Workspaces:
    The WorkspaceIds parameter is required for users in a Workspace tenant

  • Employers:
    The EmployerIds parameter is required for users in an Employer tenant

info

Your tenant-id should be used in places that require an employer id or workspace id. Learn more

Filters

The results can be filtered by date range, locations, employers, users, and current state.

  • ExcludeCheckOut:
    Used to get checkins that have not checked out yet. Great for knowing if a user is still at the location.
note

Results are paged and sorted by TimeIn in ascending order