Overview

The Time Clock API provides comprehensive workforce time tracking capabilities. Manage employee clock-ins, clock-outs, time activities, geofences, and retrieve timesheet data for payroll processing.

Key Concepts

Time Clocks

Time clocks are the core organizational unit. Each time clock can have its own settings, jobs, geofences, and assigned users. An account can have multiple time clocks for different departments or locations.

Time Activities

Time activities represent work records and include:

• Shifts: Regular work periods tracked by clock-in/clock-out
• Manual Breaks: Scheduled break periods (paid or unpaid)
• Time Offs: Approved PTO that appears on timesheets

Punch Source Types

Each clock event tracks its source:

Auto Clock-Out Modes

When auto clock-out occurs, the reason is tracked:

---

Available Endpoints

Time Clocks

Time Activities

Real-Time Clocking

Geofences

Timesheet & Payroll

Supporting Data

---

Constraints

---

Authentication

All endpoints require authentication via API key or OAuth 2.0.

Required Scopes

---

Validation Rules

⚠️

Important Validations

• Users must be assigned to the time clock before any operations
• Jobs must be assigned to the time clock if job tracking is required
• Cannot create/update time activities on locked or approved days
• Start time must be before end time for all activities

---

Guide Pages

---

API Reference