Clock in

post

https://api.connecteam.com/time-clock/v1/time-clocks/{timeClockId}/clock-in

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

timeClockId

integer

required

The unique identifier of the time clock

Body Params

userId

integer

required

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

jobId

string

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.

timezone

string

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.

schedulerShiftId

string

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

timestamp

integer

≥ 1

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.

locationData

object

GPS data associated with the clocking in event

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error