Get rewards payouts (claim checks)

get

https://api.fuul.xyz/api/v1/claim-checks/rewards-payouts

Returns a paginated list of rewards payouts (claim checks) for the project associated with the API key.
This endpoint allows filtering by status, user address, date range, and other criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Defaults to 1

Page number for pagination

page_size

integer

1 to 100

Defaults to 25

Number of results per page

from_date

date-time

Filter by lifecycle timestamp. For status=open uses created_at.
For status=unclaimed uses closed_at. For status=claimed uses claimed_at.
When status is omitted, date filters apply per slice (open, closed, claimed).

to_date

date-time

End of date range (ISO 8601). See from_date for which column is filtered per status.

status

string

enum

Filter by lifecycle (open, unclaimed, claimed). unclaimed returns closed rows not yet claimed on-chain (response status may be valid or expired).
When omitted, all rows are returned.

Allowed:

conversion_name

string

Filter by conversion name (payout or movement-derived)

conversion_id

uuid

Filter by conversion UUID

sort_by

string

enum

Field to sort by

Allowed:

sort_order

string

enum

Sort order

Allowed:

user_address

string

Filter by on-chain deposit address. Mutually exclusive with source_user_identifier.

source_user_identifier

string

Filter by source user identifier (email or uuid). Returns claim checks whose original_user_identifier matches. Mutually exclusive with user_address.

source_user_identifier_type

string

enum

Type of source_user_identifier. Required together with source_user_identifier.

Allowed:

reason

string

enum

Filter by payout recipient type. Use affiliate_payout for affiliate rewards or end_user_payout for end-user rewards.

Allowed:

Responses

400

Bad Request - Invalid parameters

401

Unauthorized - Missing or invalid API key

404

Project not found

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of rewards payouts (claim checks)