Saltar al contenido

Get a timesheet

Módulo Crew

GET/timesheets/{id}timesheets.get

A timesheet for one person and pay period. An approval is voided when its hours change. Returns one timesheet with its `ETag`. A timesheet the caller may not see returns 404.

  • Requiere la capacidad crew.timesheet.read.
  • Alcances de OAuth: crew.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

timesheets.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the timesheet.
fieldsFieldsNoSparse 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_]*)*$

Respuesta 200: Timesheet

timesheets.get: Timesheet
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the timesheet.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
timesheet_state"Proposed" | "Submitted" | "Approved" | "Rejected"SíTimesheet state.
project_idstring (uuid)SíIdentifier of the project worked.
membership_idstring (uuid) | nullSíIdentifier of the membership of the person who worked; null for external crew, who carry an engagement.
engagement_idstring (uuid) | nullSíIdentifier of the engagement of the person who worked when external crew; null for members.
period_startstring (date)SíFirst day of the period.
period_endstring (date)SíLast day of the period.
submitted_bystring (uuid) | nullSíIdentifier of the person who submitted the timesheet.
{
  "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",
  "timesheet_state": "Proposed",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "period_start": "2026-10-08",
  "period_end": "2026-10-08",
  "submitted_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

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