Skip to main content
GET
List referrals

Query Parameters

Example Request

Response

Notes

  • Results are ordered by created_at in descending order (newest first).
  • Use the referrer_id filter to build a referral dashboard for a specific customer.
  • Referrals with status expired are those where the referred customer did not complete a payment within the referral window (default 30 days).
  • The meta object provides pagination details to help you iterate through all results.
Combine status=pending with referrer_id to show a customer how many of their referrals are awaiting completion.

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Query Parameters

limit
integer
default:50

Page size (default 50, capped at 250). Also accepts page/per_page.

Required range: x <= 250
offset
integer

Rows to skip (overrides page-derived offset).

Required range: x >= 0
page
integer
default:1

1-based page number.

Required range: x >= 1
per_page
integer
default:50

Records per page (capped at 250).

Required range: 1 <= x <= 250

Response

Referrals for the tenant.

data
object[]
meta
object