Sign in
Affiliates

List Affiliates

Returns the shop's affiliates (customers with an affiliate code) with their stats.

get/v1/shops/{shopId}/affiliates

Request body

pageinteger

Page number.

perPageinteger

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

searchstring

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

tier_idinteger

Filter by affiliate tier ID.

status'active' | 'suspended' | 'all'

active (default), suspended, or all.

segment'active' | 'inactive' | 'new'
orderColumn'id' | 'email' | 'affiliate_code' | 'affiliate_referrer_earnings' | 'balance' | 'affiliate_balance' | 'affiliate_code_set_at' | 'referrals_count'
orderDirection'asc' | 'desc'

Example request

{
  "page": 1
}

Response

current_pageinteger
first_page_urlstring
frominteger
last_pageinteger
last_page_urlstring
next_page_urlstring
pathstring
per_pageinteger
prev_page_urlstring
tointeger
totalinteger

Example response

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "email": "customer@sellauth.test",
      "shop_id": 1,
      "balance": "0.00",
      "affiliate_balance": "0.00",
      "affiliate_code": "PARTNER10",
      "affiliate_code_set_at": "2026-08-28 18:23:02",
      "affiliate_tier_id": null,
      "affiliate_referrer_earnings": "0.00",
      "created_at": "2026-08-28T18:23:02.000000Z",
      "referrals_count": 0,
      "affiliate_tier": null
    }
  ],
  "first_page_url": "http://api.sellauth.test/v1/shops/1/affiliates?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "http://api.sellauth.test/v1/shops/1/affiliates?page=1",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "http://api.sellauth.test/v1/shops/1/affiliates?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next »",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "http://api.sellauth.test/v1/shops/1/affiliates",
  "per_page": 20,
  "prev_page_url": null,
  "to": 1,
  "total": 1
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.