Skip to content

Get a time entry

Crew module

GET/time-entries/{id}timeEntries.get

A time entry. Entries cannot overlap for one person; forgotten clock-outs close at 16 hours and are flagged. Returns one time entry with its `ETag`. A time entry the caller may not see returns 404.

  • Requires the capability crew.time_entry.read.
  • OAuth scopes: crew.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

timeEntries.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the time entry.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: TimeEntry

timeEntries.get: TimeEntry
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the time entry.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
shift_idstring (uuid) | nullYesIdentifier of the shift.
clock_instring (date-time)YesClock in.
clock_outstring (date-time) | nullYesClock out.
break_minutesintegerYesBreak minutes.Constraints: range 0 to any
kiosk_device_idstring (uuid) | nullYesIdentifier of the kiosk device.
project_idstring (uuid)YesIdentifier of the project worked.
membership_idstring (uuid) | nullYesIdentifier of the membership of the person who worked; null for external crew, who carry an engagement.
engagement_idstring (uuid) | nullYesIdentifier of the engagement of the person who worked when external crew; null for members.
source"Web" | "Mobile" | "Kiosk"YesWhere the punch came from.
auto_closed_atstring (date-time) | nullYesWhen a forgotten clock-out was closed automatically at 16 hours.
needs_reviewbooleanYesWhether the entry was closed automatically and awaits review.
meal_out_atstring (date-time) | nullYesEffective time of the entry's first Break Start punch (meal out).
meal_in_atstring (date-time) | nullYesEffective time of the entry's last Break End punch (meal in).
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "shift_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "clock_in": "2026-10-08T14:30:00Z",
  "clock_out": "2026-10-08T14:30:00Z",
  "break_minutes": 30,
  "kiosk_device_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "source": "Web",
  "auto_closed_at": "2026-10-08T14:30:00Z",
  "needs_review": false,
  "meal_out_at": "2026-10-08T14:30:00Z",
  "meal_in_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X GET "$XOS_BASE_URL/time-entries/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.timeEntries.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.time_entries.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos time-entries get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f