Time Clock: Breadcrumbs Report API

Introducing the Breadcrumbs Report API — export GPS location trails for employee shifts on a specific date across all time clocks in your account.

New Endpoints

• POST /time-clock/breadcrumbs/v1/report — Start async breadcrumbs report generation for a date
• GET /time-clock/breadcrumbs/v1/report/{fileId} — Poll report task status (in_queue → in_progress → completed)
• GET /time-clock/breadcrumbs/v1/report/{fileId}/download — Download the completed JSON report

Key Features

• Three-step async flow: request, poll, download — designed for large daily exports
• Company-wide coverage: aggregates breadcrumbs from all time clocks for the requested date
• Shift-level grouping: each activity includes timeClockId, timeActivityId, userId, and its breadcrumb trail
• Event types: motion GPS readings, geofence enter/exit, and provider state changes
• Secure download: file access is scoped to the requesting company via authenticated API calls

Authentication

• API Key (X-API-KEY header), or
• OAuth 2.0 with scope time_clock.read

Use Cases

• Field compliance: verify employees were at client sites during active shifts
• Route auditing: analyze GPS trails for mobile workforces
• Enterprise integrations: pull daily breadcrumb files into external analytics or compliance systems

For the full workflow, report JSON schema, and code examples, see the Breadcrumbs Guide.