Sign in

v1

latestOpenAPI 3.1.02026-07-14801408.6 KB

/time-tracking/employees/:id/time-entries

Creates a single time entry for the specified employee. Supports five clock modes. Supports both user and account tokens. Required scope: w_time_tracking.

post/time-tracking/employees/{key}/time-entries

Path parameters

keystring required

SPI key of the employee

Request body

typestring required

Entry type. One of: time-entry, clock-in, clock-out, ergani-clock-in, ergani-clock-out

clock_in_timestring

ISO 8601 clock-in timestamp with timezone designator (UTC Z or numeric offset). Stored in UTC. Seconds and milliseconds are truncated to the start of the minute. Required for time-entry and clock-in types.

clock_out_timestring

ISO 8601 clock-out timestamp with timezone designator (UTC Z or numeric offset). Stored in UTC. Seconds and milliseconds are truncated to the start of the minute. Required for time-entry and clock-out types.

notestring

Optional note. Supported by time-entry, clock-out, ergani-clock-out types.

override_overlappingboolean

When true, archives any overlapping time entries.

Response

  1. Response shape depends on type: time-entry returns the created entry; clock-in / ergani-clock-in return a single object with clock_in_time and subsequent_clock_in_times; clock-out / ergani-clock-out return a JSON array of the entries closed by the clock-out. All times are in UTC (with Z suffix); responses include a timezone field with the IANA timezone resolved for the timesheet.
OR
OR

Example response

{
  "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",
  "timezone": "Europe/London"
}