> ## Documentation Index > Fetch the complete documentation index at: https://userepass.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Lista os afiliados > Lista os afiliados da organização, com filtros opcionais por programa, status, tier e busca textual (nome/e-mail). Resultados paginados por cursor. ## OpenAPI ````yaml /openapi.json get /affiliates openapi: 3.1.0 info: title: Repass API description: >- API pública do Repass — plataforma de gestão de afiliados: programas, links, tracking, atribuição, conversões, comissões, payouts, fiscal (BR), reprocessamento, event store e webhooks. version: 0.1.0 servers: - url: https://api.userepass.com description: Produção security: - bearerAuth: [] - apiKeyAuth: [] tags: - name: Profile description: Perfil do usuário autenticado. - name: Guide description: >- Guia de onboarding do painel: estado de tours, telas visitadas e preferências por usuário e organização. - name: Portal description: >- Portal do afiliado: sessão por identidade de afiliado (sem org), convites e claim. - name: Programs description: 'Programas de afiliados: configuração, atribuição, hold e tiers.' - name: Commission Rules description: Regras de comissão versionadas (imutáveis) por programa. - name: Affiliates description: 'Ciclo de vida do afiliado: cadastro, aprovação, tier, saldo.' - name: Terms description: Termos do programa, versionados. - name: Materials description: >- Materiais (criativos) do programa: upload pelo gestor e download pelos afiliados. - name: Links description: Links rastreáveis e domínios de redirecionamento. - name: Coupons description: Cupons de afiliado e sync com gateway. - name: Pagamentos por PIX description: Habilitação de pagamentos por PIX (onboarding e documentos). - name: Tracking description: Endpoints públicos de redirect e registro de cliques. - name: Clicks description: Consulta de cliques e estatísticas de link. - name: Conversions description: 'Conversões: ingestão S2S, atribuição, matching, fraude e auditoria.' - name: Commissions description: Comissões calculadas, holds, aprovação, void e clawback. - name: Payouts description: Ciclos de pagamento, prévia, execução e comprovantes. - name: Invoices description: Notas fiscais (PJ), envio e validação (BR). - name: Fraud description: Fila de revisão e decisões de fraude. - name: Reprocess description: Reprocessamento com dry-run obrigatório e relatório de impacto. - name: Events description: Histórico de eventos para auditoria e consulta. - name: Notifications description: >- Notificações ao operador (falhas de sincronização, payouts e afins) — registro in-app espelhado por e-mail aos owners/admins. - name: Webhooks description: Endpoints de webhook, entregas, retries e dead-letter. - name: Ingest description: Ingestão de eventos de cobrança (S2S e gateways). - name: Settings description: Configurações por organização (políticas e integrações). - name: Billing description: 'Plano e cobrança: contadores de uso da organização para o painel.' - name: Dashboard description: >- Métricas agregadas da operação (receita, top afiliados, conversões, comissões, novos afiliados) para a home e os relatórios do gestor. - name: Health description: Liveness do serviço. paths: /affiliates: get: tags: - Affiliates summary: Lista os afiliados description: >- Lista os afiliados da organização, com filtros opcionais por programa, status, tier e busca textual (nome/e-mail). Resultados paginados por cursor. operationId: listAffiliates parameters: - schema: default: 25 type: integer minimum: 1 maximum: 100 in: query name: limit required: false - schema: type: string pattern: ^aff_[0-9A-HJKMNP-TV-Z]{26}$ in: query name: starting_after required: false - schema: type: string pattern: ^aff_[0-9A-HJKMNP-TV-Z]{26}$ in: query name: ending_before required: false - schema: type: string example: prog_01J9Z3K8N2QF4T7B9XP0WMD5RC in: query name: program_id required: false description: Filtra afiliados por programa. - schema: type: string enum: - pending - approved - rejected - paused - banned example: approved in: query name: status required: false description: >- Filtra por status do afiliado (`pending`, `approved`, `rejected`, `paused` ou `banned`). - schema: type: string example: gold in: query name: tier required: false description: Filtra afiliados por tier. - schema: type: string minLength: 1 example: maria in: query name: q required: false description: Busca textual por nome ou e-mail do afiliado. responses: '200': description: Default Response content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string description: >- Identificador único do afiliado (prefixo `aff_` + ULID). example: aff_01J9Z3K8N2QF4T7B9XP0WMD5RC organizationId: type: string description: Organização dona do afiliado. example: org_01J9Z3K8N2QF4T7B9XP0WMD5RC programId: type: string description: Programa ao qual o afiliado pertence. example: prog_01J9Z3K8N2QF4T7B9XP0WMD5RC affiliateUserId: anyOf: - type: string - type: 'null' description: >- ID do usuário vinculado ao afiliado (preenchido após aceite do convite). `null` quando ainda não vinculado. example: user_01J9Z3K8N2QF4T7B9XP0WMD5RC name: type: string description: Nome do afiliado. example: Maria Silva email: type: string description: E-mail do afiliado. Único por programa. example: maria@exemplo.com status: type: string enum: - pending - approved - rejected - paused - banned description: Status atual do afiliado. example: approved tier: anyOf: - type: string - type: 'null' description: >- Tier atual do afiliado. `null` quando usa o tier base do programa. example: gold customCommissionRuleId: anyOf: - type: string - type: 'null' description: >- Regra de comissão customizada que sobrepõe a regra do tier. `null` quando não há customização. example: comm_01J9Z3K8N2QF4T7B9XP0WMD5RC acceptedTermsVersion: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Versão dos termos do programa aceita pelo afiliado. `null` quando ainda não aceitou. example: 3 payoutMethod: type: string enum: - pix description: >- Método de pagamento usado nos payouts. Atualmente apenas `pix` (PIX). example: pix pixKey: anyOf: - type: string - type: 'null' description: >- Chave PIX do afiliado. `null` quando não configurada. example: maria@exemplo.com pixKeyType: anyOf: - type: string enum: - cpf - cnpj - email - phone - random description: >- Tipo da chave PIX. `cpf`: CPF. `cnpj`: CNPJ. `email`: e-mail. `phone`: telefone. `random`: chave aleatória. example: email - type: 'null' description: >- Tipo da chave PIX (`cpf`, `cnpj`, `email`, `phone` ou `random`). `null` quando não configurada. example: email cnpj: anyOf: - type: string - type: 'null' description: >- CNPJ do afiliado normalizado a 14 dígitos. `null` quando não informado. example: '11222333000181' importedTotalEarnedCents: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Total histórico ganho em centavos ao importar de outra plataforma (ex.: 1990 = R$19,90). `null` quando não importado. example: 1990 importedSince: anyOf: - type: string format: date-time - type: 'null' description: >- Data de início do relacionamento ao importar de outra plataforma (ISO-8601). `null` quando não importado. example: '2026-06-13T12:00:00.000Z' createdAt: description: Data de criação do afiliado (ISO-8601). example: '2026-06-13T12:00:00.000Z' type: string format: date-time updatedAt: description: Data da última atualização do afiliado (ISO-8601). example: '2026-06-13T12:00:00.000Z' type: string format: date-time required: - id - organizationId - programId - affiliateUserId - name - email - status - tier - customCommissionRuleId - acceptedTermsVersion - payoutMethod - pixKey - pixKeyType - cnpj - importedTotalEarnedCents - importedSince - createdAt - updatedAt additionalProperties: false hasMore: type: boolean nextCursor: anyOf: - type: string - type: 'null' description: Cursor da próxima página (use em starting_after). previousCursor: anyOf: - type: string - type: 'null' description: Cursor da página anterior (use em ending_before). required: - data - hasMore - nextCursor - previousCursor additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- Chave de API (prefixo `rstr_`) enviada como `Authorization: Bearer rstr_...`. apiKeyAuth: type: apiKey in: header name: x-api-key description: Chave de API (prefixo `rstr_`) enviada no header `x-api-key`. ````