Skip to main content
List claims

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.

Query Parameters

fields
string

Return only these fields of each row, comma-separated; use dots for nested fields, such as agreement.id. id is always returned. Fields: id, agreement, suppliers, title, status, creator, created_at, updated_at, refund_summary, summary.

mine
enum<string>

Only records matched by the filters of teams you belong to. Teams combine with OR; other filters combine with AND. Cannot be combined with team_ids.

Available options:
true,
false
team_ids
string

Only records matched by the filters of these teams: at most 50, comma-separated in a query string or an array in a JSON body. Teams combine with OR. Unknown teams return 404.

supplier_ids
string

Comma-separated, at most 50 values.

agreement_ids
string

Comma-separated, at most 50 values.

statuses
string

Comma-separated: pending, in_progress, completed, cancelled.

creator_user_ids
string

Comma-separated, at most 50 values.

Text in the claim title or supplier name.

Required string length: 1 - 200
created_from
string

Claims created on or after this calendar date in the organization's timezone.

Pattern: ^\d{4}-\d{2}-\d{2}$
created_through
string

Claims created on or before this calendar date in the organization's timezone.

Pattern: ^\d{4}-\d{2}-\d{2}$
refunded_from
string

Refunds recorded on or after this calendar date in the organization's timezone. Keeps only claims with such a refund, and refund_summary counts only those refunds.

Pattern: ^\d{4}-\d{2}-\d{2}$
refunded_through
string

Refunds recorded on or before this calendar date in the organization's timezone. Keeps only claims with such a refund, and refund_summary counts only those refunds.

Pattern: ^\d{4}-\d{2}-\d{2}$
limit
integer
default:50

Maximum number of results per page.

Required range: 1 <= x <= 1000
cursor
string

Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.

Maximum string length: 4096
sort
enum<string>
default:created_at
Available options:
created_at,
updated_at
direction
enum<string>
default:desc
Available options:
asc,
desc

Response

A page of claims.

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