Skip to content

Get a time entry correction

Crew module

GET/time-entry-corrections/{id}timeEntryCorrections.get

A requested correction to a time entry. Returns one time entry correction with its `ETag`. A time entry correction 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

timeEntryCorrections.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the time entry correction.
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: TimeEntryCorrection

timeEntryCorrections.get: TimeEntryCorrection
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the time entry correction.
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.
time_entry_idstring (uuid)YesIdentifier of the time entry.
reasonstringYesWhy the correction is needed.Constraints: length 1 to 20000
correction_state"Proposed" | "Approved" | "Rejected"YesCorrection state.
proposed_clock_instring (date-time)YesProposed clock in.
proposed_clock_outstring (date-time) | nullYesProposed clock out.
proposed_break_minutesintegerYesProposed unpaid break minutes.Constraints: range 0 to any
requested_bystring (uuid) | nullYesIdentifier of the person who asked for the correction.
{
  "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",
  "time_entry_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "reason": "Forgot to clock out at wrap.",
  "correction_state": "Proposed",
  "proposed_clock_in": "2026-10-08T14:30:00Z",
  "proposed_clock_out": "2026-10-08T14:30:00Z",
  "proposed_break_minutes": 30,
  "requested_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

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