Skip to content

List lost found item rows

Workforce module

GET/lost-found-itemslostFoundItems.list

An item in the lost and found log, with photos as attachments and its claim state. Returns a cursor page of lost found item rows the caller may see. The default order is `found_at` descending, newest first. Supports sparse fieldsets and the filter grammar.

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

Path and query parameters

lostFoundItems.list: Path and query parameters
FieldTypeRequiredDescription
limitLimitNoPage size. Default 50, maximum 200.Constraints: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
fieldsFieldsNoSparse 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_]*)*$
sortSortNoSort 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_]*)*$
filterFilterNoFilter 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 LostFoundItem

lostFoundItems.list: LostFoundItem
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the lost found item.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesPerson who last updated the row; null for seed, platform or system writes.
project_idstring (uuid)YesIdentifier of the project.
item_numberstringYesDisplay number.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
category"Wallet" | "Bag" | "Clothing" | "Electronics" | "Jewelry" | "Keys" | "Documents" | "Other"YesCategory.
descriptionstringYesDescription a claimant is checked against.Constraints: length 1 to 1000
found_atstring (date-time)YesWhen it was found.
found_locationstringYesWhere it was found.Constraints: length 1 to 200
storage_locationstring | nullYesWhere it is held.Constraints: length 1 to 200
logged_by_membership_idstring (uuid) | nullYesIdentifier of the member who logged it.
item_state"Logged" | "Claimed" | "Returned" | "Disposed"YesItem state.
{
  "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",
      "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "item_number": "LF-0001",
      "category": "Wallet",
      "description": "Brown leather wallet.",
      "found_at": "2026-10-08T14:30:00Z",
      "found_location": "Bar 2",
      "storage_location": "Security office locker 4",
      "logged_by_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "item_state": "Logged"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/lost-found-items" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.lostFoundItems.listAll()) {
  console.log(row);
}
for row in xos.lost_found_items.list_all():
    print(row)
xos lost-found-items list --all