> ## Documentation Index > Fetch the complete documentation index at: https://docs.ephra.io/llms.txt > Use this file to discover all available pages before exploring further. # Listar afiliados > Lista quem se afiliou aos produtos da empresa autenticada, do pedido mais recente para o mais antigo, com o percentual de comissão do programa e a situação de cada um. Filtre por `status` para achar rapidamente os pedidos pendentes de aprovação. ## OpenAPI ````yaml /openapi.yaml get /v1/affiliates openapi: 3.0.3 info: title: Ephra API description: >- API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks e a API do vendedor sobre catálogo, checkout, vendas, reembolsos, financeiro, crescimento e plataforma. **Limite de requisições.** 1000 requisições por minuto por IP de origem. Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a resposta é `429` com `retry-after`. **Erros.** Toda falha responde o mesmo envelope: `{ "success": false, "message": "..." }`. version: 1.0.0 servers: - url: https://api.ephra.io description: Servidor de produção security: [] tags: - name: Catálogo description: Produtos, ofertas, categorias e cupons — o que a empresa vende. - name: Checkout description: Checkouts, order bumps, upsells e links de pagamento. - name: Vendas description: Vendas, clientes, assinaturas e entregas já realizadas. - name: Reembolsos description: Pedidos de reembolso, contestações e o quiz de retenção. - name: Financeiro description: Saldo, saques, antecipações, taxas e extratos da empresa. - name: Crescimento description: Afiliados, coprodução, indicações, pixels e integrações de marketing. - name: Plataforma description: Conta, membros, chaves de API, webhooks e configurações gerais. paths: /v1/affiliates: get: tags: - Crescimento summary: Listar afiliados description: >- Lista quem se afiliou aos produtos da empresa autenticada, do pedido mais recente para o mais antigo, com o percentual de comissão do programa e a situação de cada um. Filtre por `status` para achar rapidamente os pedidos pendentes de aprovação. operationId: listAffiliates parameters: - schema: type: integer minimum: 1 default: 1 in: query name: page required: false description: Página desejada, começando em 1. - schema: type: integer minimum: 1 maximum: 100 default: 10 in: query name: pageSize required: false description: Quantidade de itens por página (máximo 100). - schema: type: string enum: - pending - approved - rejected - inactive in: query name: status required: false description: Filtra por situação do afiliado. responses: '200': description: Página de afiliados dos produtos da empresa. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: array items: type: object properties: id: type: string description: >- Identificador da afiliação, usado para aprovar ou bloquear o afiliado. affiliateName: type: string nullable: true description: Nome da empresa afiliada que divulga o produto. productName: type: string nullable: true description: Produto ao qual o afiliado está vinculado. commissionPercentage: type: integer nullable: true description: >- Percentual de comissão do programa de afiliados do produto, de 0 a 100. status: type: string enum: - pending - approved - rejected - inactive description: >- Situação do afiliado: pendente, aprovado, recusado ou inativo. createdAt: type: string format: date-time description: Momento em que o afiliado pediu a afiliação. required: - id - affiliateName - productName - commissionPercentage - status - createdAt additionalProperties: false pagination: type: object properties: page: type: integer description: Página devolvida. pageSize: type: integer description: Itens por página pedidos. total: type: integer description: Total de itens que satisfazem o filtro. totalPages: type: integer description: Total de páginas disponíveis. required: - page - pageSize - total - totalPages additionalProperties: false required: - success - data - pagination additionalProperties: false description: Página de afiliados dos produtos da empresa. example: success: true data: - id: clx9b3k7m0002qz0a5f6g7h8i affiliateName: Marketing Digital Ltda productName: Curso de Tráfego Pago commissionPercentage: 40 status: pending createdAt: '2026-09-08T14:22:00.000Z' pagination: page: 1 pageSize: 10 total: 1 totalPages: 1 '401': description: Token ausente, inválido, expirado ou de empresa bloqueada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: Token ausente, inválido, expirado ou de empresa bloqueada. example: success: false message: Token inválido ou expirado '422': description: A requisição não passou na validação de schema. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: A requisição não passou na validação de schema. example: success: false message: 'name: Nome é obrigatório' '429': description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. example: success: false message: Muitas requisições. Tente novamente em breve. headers: retry-after: $ref: '#/components/headers/retry-after' x-ratelimit-limit: $ref: '#/components/headers/x-ratelimit-limit' x-ratelimit-remaining: $ref: '#/components/headers/x-ratelimit-remaining' x-ratelimit-reset: $ref: '#/components/headers/x-ratelimit-reset' '500': description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. example: success: false message: Erro interno do servidor security: - bearerAuth: [] components: headers: retry-after: description: Segundos a esperar antes de repetir a requisição. schema: type: integer x-ratelimit-limit: description: Teto de requisições na janela (1000). Presente em toda resposta. schema: type: integer x-ratelimit-remaining: description: >- Quantas requisições ainda cabem na janela atual. Presente em toda resposta. schema: type: integer x-ratelimit-reset: description: Segundos até o contador da janela zerar. Presente em toda resposta. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````