Sign in

v1

latestOpenAPI 3.1.1LicenseRef-Proprietary2026-07-1310179223.1 KB
Timecards

Clock In

Clock a user in. Starts a new timecard segment at the current time.

post/users/{user_id}/timecards/clock-in

Path parameters

user_idnumber required
Example:89

User ID

Request body

userDatestring

Current user date, if not specified we will rely on user profile timezone.

Example request

{
  "userDate": "2020-11-27"
}

Response

OK

usernumber required

User ID

clockInstring

Clock-in time in user timezone

clockOutstring

Clock-out time in user timezone

breakTimenumber

Breaks duration in seconds

workTimenumber required

Working time in seconds

datestring

Format: Y-m-d

weekIdinteger

Week identifier (YYWW).

isLockedboolean
invalidobject nullable

Validation issues for the timecard, if any.

lockReasonsstring[]

Example response

{
  "user": 69,
  "clockIn": "09:00",
  "clockOut": "18:00",
  "breakTime": 3600,
  "workTime": 28800,
  "history": [
    {
      "action": "clock-in",
      "previousTime": "08:00",
      "time": "09:00",
      "trigger": "manually"
    }
  ]
}