Skip to main content
GET
/
affiliates
List affiliates
curl --request GET \
  --url https://api.affonso.io/v1/affiliates \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "tracking_id": "<string>",
      "source": "<string>",
      "partnership_status": "PENDING",
      "onboarding_completed": true,
      "program_id": "<string>",
      "group_id": "<string>",
      "external_user_id": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "total_pages": 123,
    "has_next_page": true,
    "has_prev_page": true
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Prefix with 'sk_live_' for production or 'sk_dev_' for development.

Query Parameters

page
integer
default:1

Page number (1-based)

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

Number of items per page

Required range: 1 <= x <= 200
partnership_status
enum<string>

Filter by partnership status

Available options:
pending,
approved,
rejected

Search by name, username, tracking ID, or email

Maximum string length: 100
group_id
string

Filter by affiliate group ID

program_id
string

Filter by program ID

sort
string

Sort field and direction

Example:

"createdAt:desc"

dateFrom
string<date-time>

Filter by creation date (from)

dateTo
string<date-time>

Filter by creation date (to)

expand
string

Comma-separated list of fields to expand

Example:

"promoCodes,commissionOverrides,invoiceDetails,payoutMethod"

Response

List of affiliates

success
boolean
data
object[]
pagination
object