List work details rows

Identity module

GET/work-detailsworkDetails.list

The caller's own work details (Section 4.5.6 item 10): uniform sizes, dietary and accessibility needs and the travel profile. Read and written only by the person; an engaging org sees a category only while the person shares it with that engagement. The passport number is Restricted and encrypted: it is written here, always read masked, and shown only through the logged revealPassport action. One live row per person (409 on a second). Returns a cursor page of work details rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Requires the capability me.work_details.write.
OAuth scopes: me.
Cursor-paginated: limit, cursor, fields, sort and filter apply.
Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

workDetails.list: Path and query parameters
Field	Type	Required	Description
limit	Limit	No	Page size. Default 50, maximum 200.Constraints: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: 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).Constraints: 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.

Response 200: a page of WorkDetails

workDetails.list: WorkDetails
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the work details.
created_at	string (date-time)	Yes	When the row was created.
updated_at	string (date-time)	Yes	When the row was last updated.
person_id	string (uuid)	Yes	Identifier of the person the work details belong to; always the caller.
shirt_size	GarmentLetterSize \| null	Yes
jacket_size	GarmentLetterSize \| null	Yes
pants_size	string \| null	Yes	Pants size as the person writes it.Constraints: length 1 to 20
shoe_size	string \| null	Yes	Shoe size with its system.Constraints: length 1 to 20
glove_size	GarmentLetterSize \| null	Yes
hat_size	string \| null	Yes	Hat size as the person writes it.Constraints: length 1 to 20
uniform_notes	string \| null	Yes	Anything else about fit.Constraints: length 1 to 500
dietary_needs	array of DietaryNeed	Yes	Dietary needs, each once, in enum order.
allergies	string \| null	Yes	Allergies in the person's words, with how severe.Constraints: length 1 to 500
dietary_notes	string \| null	Yes	Other dietary notes.Constraints: length 1 to 500
accessibility_needs	array of AccessibilityNeed	Yes	Accessibility needs, each once, in enum order.
accessibility_notes	string \| null	Yes	Accessibility needs in the person's words.Constraints: length 1 to 1000
seat_preference	SeatPreference \| null	Yes
meal_preference	string \| null	Yes	Preferred in-flight meal.Constraints: length 1 to 100
home_airport	string \| null	Yes	IATA airport code.Constraints: pattern ^[A-Z]{3}$
passport_number	string \| Masked \| null	Yes
passport_number_last4	string \| null	Yes	Last four characters of the passport number.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
passport_issuing_country	string \| null	Yes	Country that issued the passport.Constraints: pattern ^[A-Z]{2}$
passport_expires_on	string (date) \| null	Yes	Day the passport expires.
passport_name	string \| null	Yes	Name exactly as printed in the passport.Constraints: length 1 to 200

{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "created_at": "2026-10-08T14:30:00Z",
      "updated_at": "2026-10-08T14:30:00Z",
      "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "shirt_size": "XXS",
      "jacket_size": "XXS",
      "pants_size": "32x32",
      "shoe_size": "US 10.5",
      "glove_size": "XXS",
      "hat_size": "7 1/4",
      "uniform_notes": "Prefers a relaxed cut.",
      "dietary_needs": [
        "Vegan"
      ],
      "allergies": "Peanuts, severe",
      "dietary_notes": "No pork.",
      "accessibility_needs": [
        "Seating"
      ],
      "accessibility_notes": "Needs a seat near the stage door.",
      "seat_preference": "Window",
      "meal_preference": "Vegetarian (VGML)",
      "home_airport": "MIA",
      "passport_number": "YA0000TEST",
      "passport_number_last4": "TEST",
      "passport_issuing_country": "US",
      "passport_expires_on": "2026-10-08",
      "passport_name": "IVY MARCHETTI"
    }
  ],
  "next_cursor": null
}

Code samples

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

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

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

xos work-details list --all