List time entry rows
Módulo Crew
GET/time-entriestimeEntries.list
A time entry. Entries cannot overlap for one person; forgotten clock-outs close at 16 hours and are flagged. Returns a cursor page of time entry rows the caller may see. The default order is `clock_in` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad crew.time_entry.read.
- Alcances de OAuth: crew.
- Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
- Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Restricciones: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Respuesta 200: una página de TimeEntry
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the time entry. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| shift_id | string (uuid) | null | Sí | Identifier of the shift. |
| clock_in | string (date-time) | Sí | Clock in. |
| clock_out | string (date-time) | null | Sí | Clock out. |
| break_minutes | integer | Sí | Break minutes.Restricciones: range 0 to any |
| kiosk_device_id | string (uuid) | null | Sí | Identifier of the kiosk device. |
| project_id | string (uuid) | Sí | Identifier of the project worked. |
| membership_id | string (uuid) | null | Sí | Identifier of the membership of the person who worked; null for external crew, who carry an engagement. |
| engagement_id | string (uuid) | null | Sí | Identifier of the engagement of the person who worked when external crew; null for members. |
| source | "Web" | "Mobile" | "Kiosk" | Sí | Where the punch came from. |
| auto_closed_at | string (date-time) | null | Sí | When a forgotten clock-out was closed automatically at 16 hours. |
| needs_review | boolean | Sí | Whether the entry was closed automatically and awaits review. |
| meal_out_at | string (date-time) | null | Sí | Effective time of the entry's first Break Start punch (meal out). |
| meal_in_at | string (date-time) | null | Sí | Effective time of the entry's last Break End punch (meal in). |
{
"data": [
{
"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"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/time-entries" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.timeEntries.listAll()) {
console.log(row);
}for row in xos.time_entries.list_all():
print(row)xos time-entries list --all