Skip to main content
GET
List affiliates

Authorizations

Authorization
string
header
required

API key created in Admin, API. Send it as Authorization: Bearer <key>. Each key has its own permissions and optional IP allow list.

Query Parameters

Matches the referral code, user name or email.

Maximum string length: 255
status
enum<string>
Available options:
pending,
approved,
rejected
is_active
boolean

Only active or inactive affiliates.

per_page
integer
default:25

Items per page.

Required range: 1 <= x <= 100
page
integer
default:1

Page number.

Required range: x >= 1

Response

Success.

data
object[]
required
meta
object
required