---
title: "GET /admin/affiliates"
method: GET
path: "/admin/affiliates"
tags: ["affiliate"]
---

# GET /admin/affiliates

`GET /admin/affiliates`

Retrieves list of affiliates.

## Query parameters

- `id` string
- `ref_code` string
- `email` string
- `coupon` string
- `status` 'pending' | 'approved' | 'invited' | 'rejected'
- `since_id` string
- `created_at_max` string
- `created_at_min` string
- `updated_at_max` string
- `updated_at_min` string
- `fields` string[], required

## Response `200`

- object
  - `affiliates` Affiliate[]
    - `id` integer — Affiliate id of the affiliate
    - `name` string
    - `first_name` string
    - `last_name` string
    - `facebook` string
    - `twitter` string
    - `instagram` string
    - `website` string
    - `ref_code` string
    - `coupon` string
    - `phone` string
    - `address_1` string
    - `city` string
    - `state` string
    - `country` string
    - `zip_code` string
    - `comments` string
    - `personal_message` string
    - `gender` string
    - `honorific` string
    - `date_of_birth` string
    - `group_id` integer — The group the affiliate is part of. If the affiliate is not a part of any group, this field is empty
    - `ref_codes` string[] — List of referral codes assigned to the affiliate
    - `coupons` object[]
      - `code` string — Coupon code assigned to the affiliate
      - `discount_type` 'percentage' | 'fixed_amount' — Type of discount given by this coupon code
      - `discount_value` number — The amount of discount given
    - `tin` string — Tax Identification Number
    - `payment_method` string
    - `payment_details` object
    - `extra_1` string
    - `extra_2` string
    - `extra_3` string
    - `registration_ip` string
    - `commission` object
      - `type` 'percentage' | 'fixed_amount' | 'fixed_amount_on_order'
      - `amount` integer
      - `on` 'product' | 'order' — The commission to be given on. Useful if you wish to give flat rate commission on the entire order instead of giving commission on a per product basis

## Other responses

- `403` — Not authenticated

---

[API](https://skmtc.dev/goaffpro/apis/goaffpro-api.md) · [All operations](https://skmtc.dev/goaffpro/apis/goaffpro-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/goaffpro/goaffpro-api/revisions/832de9c7d0ae/schema)