---
title: "List all affiliates"
method: GET
path: "/v1/affiliates"
tags: ["Affiliates"]
---

# List all affiliates

`GET /v1/affiliates`

Retrieve a paginated list of your affiliates with their referral link, click and conversion counts, and lifetime commission. Affiliates who were invited but have not yet joined a program are not included.

## Query parameters

- `page_number` number
- `page_size` number

## Response `200`

Successfully retrieved affiliates

- AffiliateListEntity
  - `items` AffiliateEntity[], required — List of affiliate items
    - `id` string, required — Unique identifier for the object.
    - `mode` 'test' | 'prod' | 'sandbox', required — String representing the environment.
    - `object` string, required — String representing the object's type. Objects of the same type share the same value.
    - `email` string, required — The email address the affiliate was invited with.
    - `name` string, nullable — The display name of the affiliate, if set.
    - `status` string, required — The affiliate's status within your program, reflecting their membership standing: `active`, `pending` (awaiting approval), `rejected`, `suspended`, or `inactive` (left or removed). Invited-but-not-yet-joined affiliates are not returned by this endpoint.
    - `referral_code` string, required — The affiliate's unique referral code.
    - `referral_link` string, required — The affiliate's shareable referral link. Traffic arriving through it is attributed to this affiliate.
    - `clicks` number, required — Total number of clicks recorded on the affiliate’s links.
    - `conversions` number, required — Total number of conversions attributed to the affiliate.
    - `earnings` number, required — Lifetime commission earned by the affiliate, in cents (1000 = $10.00), reported in a single primary currency (see `currency`). Affiliates earning in multiple currencies show only their highest-earning currency here; use the affiliate's commissions endpoint for the full per-currency breakdown.
    - `currency` string, required — Three-letter ISO currency code, in uppercase, for the `earnings` amount. This is the affiliate's primary (highest-earning) currency; commissions in other currencies are listed individually on the commissions endpoint.
  - `pagination` PaginationEntity, required
    - `total_records` number, required — Total number of records in the list
    - `total_pages` number, required — Total number of pages available
    - `current_page` number, required — The current page number
    - `next_page` number, nullable, required — The next page number, or null if there is no next page
    - `prev_page` number, nullable, required — The previous page number, or null if there is no previous page

## Other responses

- `400` — Bad Request - Invalid input parameters
- `401` — Unauthorized - Invalid or missing API key
- `404` — Not Found - Resource does not exist

---

[API](https://skmtc.net/creem/apis/creem-api.md) · [All operations](https://skmtc.net/creem/apis/creem-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/creem/creem-api/versions/aa593160d96c/schema)