🚧

This endpoint uses the w_time_tracking scope, which must be enabled through the Integrations section found within the Settings menu.

This endpoint supports both user tokens and account tokens.

Entry types

The type field determines which additional fields are required:

ergani-* types are for the Greek Ergani work registry and do not accept an explicit timestamp.

📘

With user tokens, clock-in, clock-out, ergani-clock-in, and ergani-clock-out only act on the token owner's own time entries — even managers and admins cannot clock another employee in or out on their behalf. Use the time-entry type (with both clock_in_time and clock_out_time) to record entries for other employees, or use an account token.

Setting override_overlapping: true archives any overlapping time entries for the same employee. When an active clock-in exists, subsequent clock-in requests will return a conflict error even if override_overlapping: true — the employee must be clocked out first.

Validation rules

• Time format: ISO 8601 with a timezone designator — UTC (Z) or a numeric offset (e.g. 2024-09-27T09:00:00Z, 2024-09-27T11:00:00+02:00). Times are stored in UTC.
• Seconds and milliseconds: Truncated to the start of the minute server-side (e.g. 09:00:45.123 is persisted as 09:00:00.000).
• Clock-out time: Must be greater than or equal to clock-in time, and on the same date as clock-in or exactly at the start of the next day in the employee's timezone.
• Employee start date: Time entries cannot be prior to the employee's start date (compared against the employee's local time).
• Active clock: Cannot clock in if the employee already has an active clock.
• Clock-out: Cannot clock out if the employee has no active clock.

Response

The response shape depends on the submitted type. Time strings are returned as ISO 8601 in UTC (with the Z suffix, e.g. 2024-09-27T09:00:00.000Z) — see GET /time-tracking/time-entries for details. Responses also include a timezone field with the IANA timezone resolved for the timesheet — use it to render wall-clock time when needed.

time-entry

Returns the created entry.

{
  "type": "time-entry",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "clock_in_time": "2024-09-27T09:00:00.000Z",
  "clock_out_time": "2024-09-27T17:00:00.000Z",
  "note": null,
  "timezone": "Europe/London"
}

clock-in / ergani-clock-in

Returns a single object describing the resulting active clock.

{
  "type": "clock-in",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "clock_in_time": "2024-09-27T09:00:00.000Z",
  "subsequent_clock_in_times": [],
  "timezone": "Europe/London"
}

clock-out / ergani-clock-out

Returns a JSON array of the entries closed by the clock-out. A single clock-out can close multiple prior clock-ins, so this may contain more than one element.

[
  {
    "type": "clock-out",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "clock_in_time": "2024-09-27T09:00:00.000Z",
    "clock_out_time": "2024-09-27T17:00:00.000Z",
    "note": "End of shift",
    "worked_hours": 8,
    "worked_minutes": 0,
    "timezone": "Europe/London"
  }
]

Error responses