List referral codes

GET

/referral-codes

List referral codes

Authorizations

bearerAuth

Generate an API token here

Type

HTTP (bearer)

Parameters

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type

string

Required

Example"2025-11-01"

Pattern

"^\\d{4}-\\d{2}-\\d{2}$"

Query Parameters

page

1-based page index

Type

integer

Default

1

Exclusive Minimum

0

Maximum

4294967295

per_page

Page size

Type

integer

Default

10

Exclusive Minimum

0

Maximum

100

Responses

success.referral.list

Content-Type

application/json

object

object[]

Required

Minimum0

Maximum9007199254740991