Docs/Mobile App
Mobile App

Mobile API Reference

Current Free and Pro mobile REST route overview for app integration and testing.

Free mobile REST routes

The Free plugin exposes mobile routes for login, refresh token, logout, profile, config, device registration, clock actions, today's attendance, attendance history, active users, license sync, announcements, and Inbox read access.

Pro mobile REST routes

Pro includes the Free-style mobile app flow and adds advanced route support for GPS pings, face enrollment, face verification, face status, face login, two-way Inbox send/reply/read, and notification read tracking.

Common Pro route areas

  • /login, /refresh-token, /logout
  • /me, /config, /register-device
  • /clock, /attendance/today, /attendance/history
  • /gps-ping
  • /face/enroll, /face/verify, /face/status, /face/login
  • /inbox, /inbox/send, /inbox/reply, /inbox/read
  • /license-sync and /agency/license-sync

Security behavior

Authenticated mobile routes use token permission checks. Mobile login is blocked when mobile API is disabled, license state is invalid, the employee is disabled, or the employee's mobile access flag is disabled.