Saltar al contenido

List lost found claim rows

Módulo Workforce

GET/lost-found-claimslostFoundClaims.list

A claim on a lost item: the claimant, their contact (Confidential), their proof and how it was settled. Returns a cursor page of lost found claim rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad safety.incident.read.
  • Alcances de OAuth: safety.
  • 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

lostFoundClaims.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
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_]*)*$
sortSortNoSort 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_]*)*$
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.

Respuesta 200: una página de LostFoundClaim

lostFoundClaims.list: LostFoundClaim
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the lost found claim.
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íPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíPerson who last updated the row; null for seed, platform or system writes.
lost_found_item_idstring (uuid)SíIdentifier of the item claimed.
claimant_namestringSíClaimant.Restricciones: length 1 to 200
claimant_contactstringSíClaimant phone or email.Restricciones: length 1 to 200
proof_descriptionstringSíHow they proved it.Restricciones: length 1 to 1000
recorded_by_membership_idstring (uuid) | nullSíIdentifier of the member who took the claim.
decided_by_membership_idstring (uuid) | nullSíIdentifier of the member who settled it.
decided_atstring (date-time) | nullSíWhen it was settled.
returnedboolean | nullSíTrue when returned, false when rejected.
decision_notestring | nullSíWhy rejected, or a return note.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",
      "lost_found_item_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "claimant_name": "Riley Park",
      "claimant_contact": "+1 305 555 0142",
      "proof_description": "Named the card inside.",
      "recorded_by_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "decided_by_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "decided_at": "2026-10-08T14:30:00Z",
      "returned": true,
      "decision_note": "ID matched."
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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