Get rewards payouts totals

get

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

Returns the total amounts of rewards payouts (claim checks) grouped by currency for the project associated with the API key.
This endpoint allows filtering by status and date range.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

from_date

date-time

Start of date range (ISO 8601). Column depends on status (see list endpoint).

to_date

date-time

End of date range (ISO 8601)

status

string

enum

Filter by lifecycle (open, unclaimed, claimed). Same semantics as the list endpoint.
When omitted, all rows are included.

Allowed:

conversion_name

string

Filter by conversion name

conversion_id

uuid

Filter by conversion UUID

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

200Totals of rewards payouts grouped by currency