Skip to main content
GET
List Affiliates

Authorizations

Authorization
string
header
required

You can retrieve your API key from your dashboard under Account > Developers.

Path Parameters

shopId
integer
required

The shop ID.

Body

application/json
page
integer

Page number.

Example:

1

perPage
integer

Items per page, 1-100. Must be at least 1. Must not be greater than 100.

Example:

null

Search by email or affiliate code. Must not be greater than 100 characters.

Example:

null

tier_id
integer

Filter by affiliate tier ID.

Example:

null

status
enum<string>

active (default), suspended, or all.

Available options:
active,
suspended,
all
Example:

null

segment
enum<string>
Available options:
active,
inactive,
new
Example:

null

orderColumn
enum<string>
Available options:
id,
email,
affiliate_code,
affiliate_referrer_earnings,
balance,
affiliate_balance,
affiliate_code_set_at,
referrals_count
Example:

null

orderDirection
enum<string>
Available options:
asc,
desc
Example:

null

Response

200 - application/json
current_page
integer
Example:

1

data
object[]
Example:
first_page_url
string
Example:

"http://api.sellauth.test/v1/shops/1/affiliates?page=1"

from
integer
Example:

1

last_page
integer
Example:

1

last_page_url
string
Example:

"http://api.sellauth.test/v1/shops/1/affiliates?page=1"

Example:
next_page_url
string
Example:

null

path
string
Example:

"http://api.sellauth.test/v1/shops/1/affiliates"

per_page
integer
Example:

20

prev_page_url
string
Example:

null

to
integer
Example:

1

total
integer
Example:

1