COconnecteam
Time Clock:v1:TimeClocks:TimeClock:ClockIn

Clock in

Changed on

Record the start time for the work period of an employee. The start time is automatically captured when the call is executed.

post/time-clock/v1/time-clocks/{timeClockId}/clock-in

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/time-clock/v1/time-clocks/{timeClockId}/clock-in
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: time_clock.write

Path parameters

timeClockIdinteger required

The unique identifier of the time clock

Request body

userIdinteger required

The unique identifier of the user. Make sure the user is assigned to the specified time clock.

jobIdstring

The unique identifier of the associated job or sub-job. Make sure the job is assigned to the specified time clock. This field is required if the setting to enforce job assignment for time clock usage is enabled.

timezonestring

The timezone in Tz format (e.g. America/New_York). If timezone is not specified, it will use the default timezone in the time clock settings.

schedulerShiftIdstring

The scheduled shift from the schedule associated with the clocking in event

timestampinteger

The clock-in time in Unix format (in seconds). If omitted, the server captures the time when the request is received. Must be no more than 12 hours in the past and not in the future. Use to record a clock-in that already happened - typically when a physical clock device is flushing queued punches after recovering from offline mode.

Response

Successful Response

requestIdstring

Changes

  • a01dde7c27fbRevision changes
    • warning

      added the new breakAutoEnd enum value to the //////// response property for the response status

    • warning

      added the new breakAutoEnd enum value to the //////// response property for the response status