Clock in an employee

Start a new time record for an employee. If the employee already has an active record of a different type (e.g. switching from work to break), the existing record is automatically clocked out first. Use type "switch" to replace the current work record (e.g. changing customer/project) — this auto-clocks out the existing record and creates a new "work" record. Returns 409 if the employee already has an active record of the same type. Returns 400 if the company requires a customer or project and neither is provided. Returns 400 if the specified customer or project is disabled. Returns 400 if job geofencing applies but start_coordinates is missing or invalid, or if coordinates are outside the allowed perimeter. Returns 429 if a concurrent clock-in is already being processed for this employee. The auto clock-out expiration is set based on the company's daily cut-off time. Also emits the same live admin websocket update as internal clock-in.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

ID of the employee to clock in

string
enum

Type of time record. "work" and "break" are standard types. "switch" auto-clocks out the current work record and starts a new one (e.g. switching customer/project). Stored as "work" internally. Defaults to "work".

Allowed:
string

Optional clock-in note

integer

Optional customer/job to associate with this record

integer

Optional project to associate with this record

string

Device GPS as latitude,longitude (e.g. "40.7128,-74.0060"). Required when job geofencing applies for this employee and customer/project (same rules as the Friday mobile app); optional otherwise. Configure fences in the Friday web app.

string
length ≤ 500

Optional human-readable label for the clock-in location (used in notifications and reports).

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json