List work detail event rows

Módulo Identity

GET/work-detail-eventsworkDetailEvents.list

One entry of a person's work details access log (Section 8.4): a change they made, a share or revocation, or a read or reveal by an engaging org, with the categories and changed column names but never a value. The person reads all of theirs; an org's audit readers read the entries naming their org. Returns a cursor page of work detail event rows the caller may see. The default order is `created_at` descending, newest first. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad me.work_details.write.
Alcances de OAuth: me.
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

workDetailEvents.list: 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 WorkDetailEvent

workDetailEvents.list: WorkDetailEvent
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the entry.
person_id	string (uuid)	Sí	Identifier of the person whose work details were touched.
actor_person_id	string (uuid) \| null	Sí	Identifier of the person who acted; null for the database or a service.
org_id	string (uuid) \| null	Sí	Identifier of the org whose member acted or whose share changed.
engagement_id	string (uuid) \| null	Sí	Identifier of the engagement of a share, read or reveal.
action	string	Sí	What happened, as subject.verb: person_work_details.update, work_details.shared, work_details.share_changed, work_details.share_revoked, work_details.viewed, passport.revealed and others.Restricciones: pattern ^[a-z][a-z0-9_]\.[a-z][a-z0-9_]$
categories	array of WorkDetailCategory	Sí	Categories the act covered.
changed_columns	array of string	Sí	Columns an owner change touched, never their values.
reason	string \| null	Sí	Reason an org member gave for revealing the passport number.Restricciones: length 1 to 500
created_at	string (date-time)	Sí	When it happened.

{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "actor_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "action": "work_details.viewed",
      "categories": [
        "Dietary Needs"
      ],
      "changed_columns": [
        "allergies"
      ],
      "reason": "Booking the June flights.",
      "created_at": "2026-10-08T14:30:00Z"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/work-detail-events" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.workDetailEvents.listAll()) {
  console.log(row);
}

for row in xos.work_detail_events.list_all():
    print(row)

xos work-detail-events list --all