Clock out
Crew module
POST/time-entries/{id}/clock-outtimeEntries.clockOut
Closes the open time entry. Forgotten clock-outs close automatically at 16 hours and are flagged. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability crew.time_entry.write.
- OAuth scopes: crew.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the time entry. |
Response 200: TimeEntry
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the time entry. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| shift_id | string (uuid) | null | Yes | Identifier of the shift. |
| clock_in | string (date-time) | Yes | Clock in. |
| clock_out | string (date-time) | null | Yes | Clock out. |
| break_minutes | integer | Yes | Break minutes.Constraints: range 0 to any |
| kiosk_device_id | string (uuid) | null | Yes | Identifier of the kiosk device. |
| project_id | string (uuid) | Yes | Identifier of the project worked. |
| membership_id | string (uuid) | null | Yes | Identifier of the membership of the person who worked; null for external crew, who carry an engagement. |
| engagement_id | string (uuid) | null | Yes | Identifier of the engagement of the person who worked when external crew; null for members. |
| source | "Web" | "Mobile" | "Kiosk" | Yes | Where the punch came from. |
| auto_closed_at | string (date-time) | null | Yes | When a forgotten clock-out was closed automatically at 16 hours. |
| needs_review | boolean | Yes | Whether the entry was closed automatically and awaits review. |
| meal_out_at | string (date-time) | null | Yes | Effective time of the entry's first Break Start punch (meal out). |
| meal_in_at | string (date-time) | null | Yes | Effective 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 POST "$XOS_BASE_URL/time-entries/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/clock-out" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.timeEntries.clockOut("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.time_entries.clock_out("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos time-entries clock-out 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f