Skip to main content
GET
Get claims by license (paginated)
Returns claims for the authenticated license. Use query params for pagination and filtering.

Authorizations

X-API-KEY
string
header
required

Query Parameters

license
string
required

License UID

page
integer
required

Page number (1-based)

Required range: x >= 1
limit
integer
required

Page size (items per page)

Required range: x >= 1
status
enum<integer>

Claim status (0=PENDING_REVIEW, 1=APPROVED, 2=PROCESSING_PAYMENT, 3=PAID, 4=REJECTED, 5=AWAITING_FUNDS)

Available options:
0,
1,
2,
3,
4,
5
hasNoAssociatedPayment
boolean

If true, returns only claims without associated payment

Response

Paginated list of claims

claims
object[]
totalAmountToPay
number

Sum of amountToPay across every claim matching the filter, not just the returned page.

pagination
object

Cursor-like pagination structure returned alongside results.