---
title: "Affiliate index"
method: GET
path: "/api/v1/affiliates"
tags: ["affiliates"]
---

# Affiliate index

`GET /api/v1/affiliates`

## Request

- Base URL: `https://www.foxnfe.com.br`
- URL: `https://www.foxnfe.com.br/api/v1/affiliates`
- Auth: HTTP bearer

## Response `200`

Resposta implementada pelo controlador.

- object
  - `data` object
    - `referrals` object[]
      - `id` unknown
      - `referral_code` unknown
      - `referred_email` unknown
      - `status` 'draft' | 'pending' | 'processing' | 'authorized' | 'rejected' | 'denied' | 'canceled' | 'contingency'
      - `converted_at` string, date-time, nullable
    - `commissions` object[]
      - `id` unknown
      - `referral_id` unknown
      - `amount_cents` unknown
      - `status` 'draft' | 'pending' | 'processing' | 'authorized' | 'rejected' | 'denied' | 'canceled' | 'contingency'
      - `accrued_at` string, date-time
      - `reversed_at` string, date-time, nullable

---

[API](https://skmtc.dev/foxnfe/apis/fox-nf-e-api.md) · [All operations](https://skmtc.dev/foxnfe/apis/fox-nf-e-api/llms.txt) · [OpenAPI document](https://skmtc.dev/foxnfe/apis/fox-nf-e-api/revisions/8820a6e016b0?raw)