Referrals
List Referrals
Retrieve a paginated list of all referrals in your organization.
GET
List referrals
Query Parameters
Example Request
Response
Notes
- Results are ordered by
created_atin descending order (newest first). - Use the
referrer_idfilter to build a referral dashboard for a specific customer. - Referrals with status
expiredare those where the referred customer did not complete a payment within the referral window (default 30 days). - The
metaobject provides pagination details to help you iterate through all results.
Authorizations
Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.
Query Parameters
Page size (default 50, capped at 250). Also accepts page/per_page.
Required range:
x <= 250Rows to skip (overrides page-derived offset).
Required range:
x >= 01-based page number.
Required range:
x >= 1Records per page (capped at 250).
Required range:
1 <= x <= 250List referrals