Claims
List claims
GET/claims
Scope claims.read
Claims on this Business's parcels, newest first, whoever filed them (API, Business workspace).
Request
Query parameters
| Name | In | Type | Description |
|---|---|---|---|
statusOptional | query | string | Filter by status. |
limitOptional | query | integer | Page size.1 to 100Default 25 |
cursorOptional | query | string | Opaque cursor from nextCursor. |
Response
| Status | Meaning |
|---|---|
200 | A page of claims |
The body is { "status": "success", "data": … }. Fields of data (ClaimList):
| Field | Type | Description |
|---|---|---|
claimsRequired | array of Claim | |
nextCursorRequired | string or null |
Errors
Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.
| Status | When |
|---|---|
400 | The request is not valid. A field is missing or invalid, or the Idempotency-Key header is missing or malformed. |
401 | Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked. |
403 | The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED). |
429 | Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key. |