COconnecteam
Time Clock:v1:TimeClocks:TimeClock:ManualBreaks:ManualBreakClockIn

Clock in to a manual break

Changed on

Start a manual break for an employee. If the employee is clocked into a shift on the same time clock, the shift is automatically closed and the break is started in one call (attributed to the shift's job). If the employee is idle, the break starts standalone. Pass an optional timestamp to record a break that started earlier (offline sync).

post/time-clock/v1/time-clocks/{timeClockId}/manual-breaks/{manualBreakId}/clock-in

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/time-clock/v1/time-clocks/{timeClockId}/manual-breaks/{manualBreakId}/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

manualBreakIdstring required

The unique identifier of the manual break to start

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.

timezonestring

The timezone in Tz format (e.g. America/New_York). If not specified, the time clock's configured timezone is used.

timestampinteger

The break-start 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 break that already started - 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

    • warning

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