The Time Record Object

A time record represents a single clock-in / clock-out entry for an employee. Records have a type of either "work" or "break", and an active record (currently clocked in) has a null end timestamp.

Variants

Shape	Returned by	Extra fields
List item	`GET /time-records`	—
Detail	`GET /time-records/:time_record_id`, `POST /time-records/clock-in`, `POST /time-records/clock-out`	`start_coordinates`, `end_coordinates`, `expires_at`, `note_img_url`, `end_note_img_url`, `employee`

The detail shape is a superset of the list shape.

Field Reference

Core fields

Field	Type	Description
`time_record_id`	integer	Unique time record identifier.
`type`	string	Type of time record: `"work"` or `"break"`.
`start`	date-time	Clock-in timestamp.
`end`	date-time \| null	Clock-out timestamp. Null if the employee is still clocked in.
`missed_clockout`	boolean	Whether this record missed its automatic clock-out window.

Source fields

Field	Type	Description
`clockin_source`	string \| null	How the employee clocked in (e.g. `"partner_api"`, `"web"`, `"mobile"`).
`clockout_source`	string \| null	How the employee clocked out.
`start_location`	string	Human-readable label for the clock-in location.
`end_location`	string \| null	Human-readable label for the clock-out location.

Note fields

Field	Type	Description
`note`	string \| null	Clock-in note.
`end_note`	string \| null	Clock-out note.

Association fields

Field	Type	Description
`employee_id`	integer	The employee this record belongs to.
`customer_id`	integer \| null	The customer/job associated with this record.
`project_id`	integer \| null	The project associated with this record.
`customer`	object \| null	Customer summary with `customer_id` and `name`.
`project`	object \| null	Project summary with `project_id` and `name`.

Detail-only fields

Field	Type	Description
`start_coordinates`	string \| null	(Detail only) GPS coordinates at clock-in (e.g. `"40.7128,-74.0060"`).
`end_coordinates`	string \| null	(Detail only) GPS coordinates at clock-out.
`expires_at`	date-time \| null	(Detail only) Auto clock-out expiration time.
`note_img_url`	string \| null	(Detail only) Image URL attached to clock-in note.
`end_note_img_url`	string \| null	(Detail only) Image URL attached to clock-out note.
`employee`	object	(Detail only) Employee summary with `employee_id`, `first_name`, `last_name`.

Example: List Item

{
  "time_record_id": 1042,
  "type": "work",
  "start": "2026-03-05T09:00:00.000Z",
  "end": "2026-03-05T17:00:00.000Z",
  "clockin_source": "partner_api",
  "clockout_source": "partner_api",
  "start_location": "Partner API",
  "end_location": "Partner API",
  "note": "Starting morning shift",
  "end_note": null,
  "missed_clockout": false,
  "employee_id": 25,
  "customer_id": null,
  "project_id": null,
  "customer": null,
  "project": null
}

Example: Detail

{
  "time_record_id": 1042,
  "type": "work",
  "start": "2026-03-05T09:00:00.000Z",
  "end": "2026-03-05T17:00:00.000Z",
  "clockin_source": "partner_api",
  "clockout_source": "partner_api",
  "start_location": "Partner API",
  "end_location": "Partner API",
  "note": "Starting morning shift",
  "end_note": null,
  "missed_clockout": false,
  "employee_id": 25,
  "customer_id": null,
  "project_id": null,
  "customer": null,
  "project": null,
  "start_coordinates": null,
  "end_coordinates": null,
  "expires_at": "2026-03-06T00:00:00.000Z",
  "note_img_url": null,
  "end_note_img_url": null,
  "employee": {
    "employee_id": 25,
    "first_name": "John",
    "last_name": "Doe"
  }
}

Object Overview