---
title: "List partners"
method: GET
path: "/v1/partners"
tags: ["Partners"]
---

# List partners

`GET /v1/partners`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/partners`
- Auth: HTTP bearer

**Scope:** `read`

## Query parameters

- `program_id` string, required: Required on every list
- `limit` string: 1 to 100, default 25
- `starting_after` string: Object id; returns the page after it (older)
- `ending_before` string: Object id; returns the page before it (newer)
- `expand[]` union: Relations to embed: group
  - string
  - string[]
- `include[]` union: Extras to include: stats, tags
  - string
  - string[]
- `status` 'pending' | 'active' | 'declined' | 'suspended'
- `group_id` string
- `email` string
- `handle` string
- `search` string

## Response `200`

Partners

- PartnerList
  - `data` Partner[], required
    - `id` string, required: Prefixed id (`part_…`)
    - `object` 'partner', required
    - `program_id` string, required: Prefixed id (`prg_…`)
    - `group_id` string, nullable, required: Prefixed id (`grp_…`)
    - `email` string, email, required
    - `first_name` string, nullable, required
    - `last_name` string, nullable, required
    - `display_name` string, nullable, required
    - `company_name` string, nullable, required
    - `website_url` string, nullable, required
    - `country_code` string, nullable, required
    - `language_code` string, nullable, required
    - `handle` string, required: The `?ref=` value
    - `status` 'pending' | 'active' | 'declined' | 'suspended', required
    - `decline_reason` string, nullable, required
    - `suspension_reason` string, nullable, required
    - `currency` string, required: The program's currency; every amount on this partner is in it
    - `min_payout_minor` integer, nullable, required: Per-partner threshold override; null means the program's
    - `terms_accepted_at` string, date-time, nullable, required: ISO-8601, UTC
    - `terms_version` string, nullable, required
    - `completed_onboarding` boolean, required
    - `email_first_referral` boolean, required
    - `email_new_referral` boolean, required
    - `email_payout_paid` boolean, required
    - `metadata` object, nullable, required: Your own key/value data, stored as given
    - `stats` PartnerStats
      - `clicks` integer, required
      - `referrals` integer, required
      - `customers` integer, required
      - `commissions_minor` integer, required: Integer minor units (cents, pence). Never a float, never a string.
      - `paid_minor` integer, required: Integer minor units (cents, pence). Never a float, never a string.
      - `currency` string, required: ISO-4217
    - `created_at` string, date-time, required: ISO-8601, UTC
    - `updated_at` string, date-time, required: ISO-8601, UTC
  - `has_more` boolean, required: Pass the last object's id as `starting_after` to fetch the next page
  - `total_count` integer, required: Count of every object matching the filters, ignoring the cursor

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `422`: The request was understood and refused
- `429`: Rate limited: see Retry-After

---

[API](https://skmtc.dev/affiliaterail/apis/affiliaterail-api.md) · [All operations](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/revisions/ea41f345c092?raw)