For AI agents: the docs index is at https://fuul.readme.io/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Explorer
Fuul API
Charts
List Chart Builder charts
get
Get Chart Builder chart metric data
get
Claim Checks
Get rewards payouts (claim checks)
get
Get rewards payouts totals
get
Generate Claim Signature
post
Get claim check totals for a user
get
List a user's completed claim rows by (hash, currency)
get
Close open claim checks for a user
post
Audiences
Get All Audience Segments
get
Get User Audience Segments
get
Get Audience Segment Entries
get
Batch Create Audience Segment Entries
post
Delete Audience Segment Entry
del
Create Audience Segment Badge
post
Update Audience Segment Badge
patch
Delete Audience Segment Badge
del
Events
Check Event Status
get
Send Batch Events
post
Send Event
post
Affiliates
Check if affiliate code is free
get
Create Affiliate Code
post
Check affiliate code availability
get
Update affiliate code
post
Get affiliate code
get
Create project affiliate (managed)
post
Get project affiliate detail (managed)
get
Update project affiliate (managed)
patch
Incentives
List project incentives (draft)
get
Create project incentive (draft)
post
Get project incentive (draft)
get
Update project incentive (draft)
patch
Terms & Conditions
Record a terms & conditions acceptance
post
Get terms & conditions status for a wallet
get
Users
Create or update user referrer relationship
put
Get referrer for a user
get
Delete user referrer relationship
del
List project referral bridge rows
get
List project attributed conversions with payouts
get
List project attributed payouts (flat export)
get
Affiliate Portal
Get project total stats
get
Get new traders referred by an affiliate
get
Get referral tree for an affiliate
get
Get affiliate stats breakdown by period
get
Get project-global affiliate breakdown
get
Get affiliate portal stats
get
List affiliates with multilevel commission rates
get
Get payout-eligible attributed volume and revenue by referral level
get
Get qualified user bonus for an affiliate
get
Get high volume taker bonus for an affiliate
get
Conversions
Get Conversion Status for User
get
Get Conversions List
get
Leaderboards
Get referred volume for a given set of user identifiers
get
Get Payouts Leaderboard
get
Get point payouts leaderboard
get
Get total volume leaderboard
get
Get total revenue leaderboard
get
Payouts
Get Pending Recipient Resolutions
get
Create Recipient Mappings
post
Get payouts for a given user address
get
Get Payouts Summary
get
Get payouts and volumes by referrer
get
Get Payout Movements
get
Get total user points
get
Referral Codes
Delete Referral
del
Get User's Referral Codes
get
Generate Referral Codes
post
Check Referral Code Availability
get
Update Referral Code
patch
Get Referral Status
get
Use Referral Code
patch
Project Invoices
Generate affiliate invoices for a period
post
Re-queue affiliate invoice PDF generation
post
List affiliate invoices
get
Close billing period (alias of generate)
post
Affiliate invoice aggregate statistics
get
List closed billing periods with invoice counts
get
Tax readiness and pending billing periods from claimed payouts
get
Download invoice PDFs as a ZIP archive
post
Affiliate Applications
Create affiliate application
post
Get affiliate application form configuration
get
Webhooks
Create Webhook Endpoint
post
List Webhook Endpoints
get
Get Webhook Endpoint
get
Update Webhook Endpoint
patch
Delete Webhook Endpoint
del
List Webhook Deliveries
get
Public
Get claimable rewards for a user
get
Get incentives listing
get
Internal
Set contract scheduled flag
patch
Explorer
Powered by
Copy Page
Explorer
Updated about 1 year ago
Set contract scheduled flag
Did this page help you?
Yes
No
Updated about 1 year ago
Set contract scheduled flag
Did this page help you?
Yes
No
