Skip to main content
List claim recoveries

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string[]

Return only these fields of each row. id is always returned. Fields: id, claim_id, amount, currency_code, comment, credit_note_id, credit_note_number, source, basis, created_by_user_id, created_at, updated_at.

limit
integer
default:50
Required range: 1 <= x <= 1000
cursor
string
Maximum string length: 4096
ids
string<uuid>[]

Only these recoveries.

Response

A page of recoveries, newest first.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required