---
title: "Retorna uma lista de participantes do split de pagamentos."
method: GET
path: "/v1/affiliates"
tags: ["affiliates"]
---

# Retorna uma lista de participantes do split de pagamentos.

`GET /v1/affiliates`

## Request

- Base URL: `//app.vindi.com.br/api` (relative, and the document’s source URL is not known)
- URL: `//app.vindi.com.br/api/v1/affiliates`
- Auth: HTTP basic

## Query parameters

- `page` integer
- `per_page` integer
- `query` string
- `sort_by` 'id' | 'login' | 'enabled' | 'status'
- `sort_order` 'asc' | 'desc'

## Response `200`

Consulta realizada com sucesso.

- Affiliate[]
  - `id` integer, required: ID do participante do split de pagamento
  - `login` string, required: Login do participante do split de pagamento
  - `status` integer: Status do participante do split de pagamento
  - `enabled` string: Define participante do split de pagamento como ativo ou inativo

## Other responses

- `400`: Erro de sintaxe JSON no corpo do request.
- `422`: Parâmetros inválidos. Verificar erro na resposta.

---

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