List workforce event rows
Módulo Workforce
GET/workforce-eventsworkforceEvents.list
A briefing, crew call or meeting for an audience, with RSVP, location, agenda and check-in. Returns a cursor page of workforce event rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad schedule.timeline.read.
- Alcances de OAuth: schedule.
- 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 WorkforceEvent
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the workforce event. |
| 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í | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Person who last updated the row; null for seed, platform or system writes. |
| event_kind | "Briefing" | "Crew Call" | "Meeting" | Sí | Event kind. |
| title | string | Sí | Event title.Restricciones: length 1 to 200 |
| agenda | string | null | Sí | Agenda, in order.Restricciones: length 1 to 20000 |
| location | string | null | Sí | Where to meet.Restricciones: length 1 to 300 |
| venue_id | string (uuid) | null | Sí | Identifier of the venue. |
| space_id | string (uuid) | null | Sí | Identifier of the space within the venue. |
| audience_kind | "Organization" | "Project" | "Team" | "Department" | "Role" | "Group" | Sí | Who the row reaches. Department (a canon department, 1365) is for feed posts only. |
| project_id | string (uuid) | null | Sí | Identifier of the project audience, or the project the row belongs to. |
| team_id | string (uuid) | null | Sí | Identifier of the team audience. |
| role_id | string (uuid) | null | Sí | Identifier of the org role audience. |
| group_id | string (uuid) | null | Sí | Identifier of the group audience, including department groups. |
| organizer_membership_id | string (uuid) | null | Sí | Identifier of the member who organizes the event. |
| starts_at | string (date-time) | Sí | Start. |
| ends_at | string (date-time) | Sí | End, at most seven days after the start. |
| rsvp_required | boolean | Sí | Whether invitees are asked to RSVP. |
| canceled_at | string (date-time) | null | Sí | When the event was canceled. |
| cancel_reason | string | null | Sí | Why it was canceled.Restricciones: length 1 to 500 |
{
"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",
"event_kind": "Briefing",
"title": "Load-in crew call",
"agenda": "1. Safety brief. 2. Assignments.",
"location": "Dock door 3",
"venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"audience_kind": "Organization",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"organizer_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"starts_at": "2026-10-08T14:30:00Z",
"ends_at": "2026-10-08T14:30:00Z",
"rsvp_required": true,
"canceled_at": "2026-10-08T14:30:00Z",
"cancel_reason": "Dock closed for repairs."
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/workforce-events" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.workforceEvents.listAll()) {
console.log(row);
}for row in xos.workforce_events.list_all():
print(row)xos workforce-events list --all