LogoLogo
REST APIWebhooksHelp Center →
  • Introduction
  • JavaScript API
    • Overview
  • REST API
    • Overview
    • Campaigns
      • The campaign object
      • List campaigns
      • Create campaign
      • Retrieve campaign
      • Update campaign
    • Affiliates
      • The affiliate object
      • List affiliates
      • Create affiliate
      • Retrieve affiliate
      • Update affiliate
      • Magic Link (SSO)
    • Affiliate Links
      • The affiliate link object
      • List affiliate links
      • Create affiliate link
      • Retrieve affiliate link
      • Update affiliate link
    • Affiliate Coupons
      • The affiliate coupon object
      • List affiliate coupons
      • Create affiliate coupon
      • Retrieve affiliate coupon
    • Referrals
      • The referral object
      • List referrals
    • Commissions
      • The commission object
      • List commissions
      • Retrieve commission
      • Update commission
      • Delete commission
    • Payouts
      • The payout object
      • List payouts
      • Retrieve a payout
      • Mark a payout as paid
  • Webhooks
    • Overview
    • Endpoints
    • Requests
    • Event types
    • Signed webhooks
  • Links
    • Help Center
    • Sign up
    • Login
    • Learn more about Rewardful
Powered by GitBook
On this page
  • Request
  • Optional parameters
  • Expandable objects
  • Examples

Was this helpful?

Export as PDF
  1. REST API
  2. Payouts

List payouts

Returns a list of your payouts. Records are returned sorted by creation date, with the most recent items appearing first.

Request

GET

https://api.getrewardful.com/v1/payouts

Optional parameters

Parameter
Description

affiliate_id

Show payouts for the specified affiliate.

state

Show payouts that are currently in the specified states.

Valid values are pending, due, processing, and paid.

You can pass state[] to specify multiple states.

Expandable objects

Parameter
Description

affiliate

Include details about the affiliate this payout is associated with.

commissions

Include details about each of the commissions constituting this payout.

Examples

List all payouts

curl --request GET \
  --url https://api.getrewardful.com/v1/payouts \
  -u YOUR_API_SECRET:

List all payouts with data for the associated affiliate and commissions

curl --request GET \
  --url https://api.getrewardful.com/v1/payouts?expand[]=affiliate&expand[]=commissions \
  -u YOUR_API_SECRET:

List payouts for a specific affiliate

curl --request GET \
  --url https://api.getrewardful.com/v1/payouts?affiliate_id=5768bd90-7953-493f-ae6c-6562eb4d7e72 \
  -u YOUR_API_SECRET:

List payouts that have been marked as paid

curl --request GET \
  --url https://api.getrewardful.com/v1/payouts?state= \
  -u YOUR_API_SECRET:

List payouts that are either due or pending

curl --request GET \
  --url https://api.getrewardful.com/v1/payouts?state[]=due&state[]=pending \
  -u YOUR_API_SECRET:
PreviousThe payout objectNextRetrieve a payout

Last updated 5 months ago

Was this helpful?