Skip to content

Record a claim

Workforce module

POST/lost-found-items/{id}/claimlostFoundItems.claim

Records a claim on a held item with the claimant's name, contact and proof. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability safety.incident.write.
  • OAuth scopes: safety.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

lostFoundItems.claim: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the lost found item.

Request body: LostItemClaimRequest

lostFoundItems.claim: LostItemClaimRequest
FieldTypeRequiredDescription
claimant_namestringYesClaimant.Constraints: length 1 to 200
claimant_contactstringYesPhone or email.Constraints: length 3 to 200
proof_descriptionstringYesProof.Constraints: length 1 to 1000
{
  "claimant_name": "Riley Park",
  "claimant_contact": "+1 305 555 0142",
  "proof_description": "Named the card inside."
}

Response 201: LostFoundClaim

lostFoundItems.claim: LostFoundClaim
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the lost found claim.
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.
lost_found_item_idstring (uuid)YesIdentifier of the item claimed.
claimant_namestringYesClaimant.Constraints: length 1 to 200
claimant_contactstringYesClaimant phone or email.Constraints: length 1 to 200
proof_descriptionstringYesHow they proved it.Constraints: length 1 to 1000
recorded_by_membership_idstring (uuid) | nullYesIdentifier of the member who took the claim.
decided_by_membership_idstring (uuid) | nullYesIdentifier of the member who settled it.
decided_atstring (date-time) | nullYesWhen it was settled.
returnedboolean | nullYesTrue when returned, false when rejected.
decision_notestring | nullYesWhy rejected, or a return note.Constraints: length 1 to 500
{
  "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."
}

Code samples

curl -X POST "$XOS_BASE_URL/lost-found-items/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/claim" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"claimant_name":"Riley Park","claimant_contact":"+1 305 555 0142","proof_description":"Named the card inside."}'
const { data } = await xos.lostFoundItems.claim("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "claimant_name": "Riley Park",
    "claimant_contact": "+1 305 555 0142",
    "proof_description": "Named the card inside."
  });
response = xos.lost_found_items.claim("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"claimant_name": "Riley Park", "claimant_contact": "+1 305 555 0142", "proof_description": "Named the card inside."})
xos lost-found-items claim 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"claimant_name":"Riley Park","claimant_contact":"+1 305 555 0142","proof_description":"Named the card inside."}'