v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Time Tracking

Public API

Create Timesheet Clock-In Entry

Clocks in an employee at the current server time. To record a historical clock-in, provide a date, start (HH:MM, 24-hour format), and timezone. You can optionally associate the entry with projectId, taskId (requires projectId), breakId, and a note.

OAuth Scopes: time_tracking.write

post/api/v1/time_tracking/employees/{employeeId}/clock_in

Path parameters

employeeIdinteger required

The internal employee ID of the employee to clock in.

Request body

projectIdinteger nullable

ID of the time tracking project that should be associated with the timesheet entry. Required if taskId is specified.

taskIdinteger nullable

ID of the time tracking task that should be associated with the timesheet entry.

notestring nullable

The note that should be associated with the timesheet entry

datestring date nullable

Date for the timesheet entry. Must be in YYYY-MM-DD format.

startstring nullable

The time for the clock in. In 24 hour format HH:MM

timezonestring nullable

The timezone associated with the clock in.

breakIdstring uuid nullable

ID of the break that should be associated with the timesheet entry.

offlineboolean

Whether this is an offline punch. When true, bypasses the shift schedule clock-in restriction. Intended for devices that store punches offline and sync later.

Example request

{
  "projectId": 10,
  "taskId": 25,
  "note": "Back from lunch.",
  "date": "2024-12-12",
  "start": "13:00",
  "timezone": "America/Denver",
  "breakId": "123e4567-e89b-12d3-a456-426614174000"
}

Response

The employee was successfully clocked in. Returns the new clock entry details.

idinteger

Timesheet entry ID

employeeIdinteger

Employee ID

typestring

Entry type

datestring date

Date of the timesheet

startstring date-time nullable

Start time

endstring date-time nullable

End time

timezonestring nullable

Timezone

hoursnumber float nullable

Hours worked

notestring nullable

Note