> ## 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. # Consulta um programa > Retorna um programa específico da sua conta pelo seu identificador. ## OpenAPI ````yaml /openapi.json get /programs/{programId} 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: /programs/{programId}: get: tags: - Programs summary: Consulta um programa description: Retorna um programa específico da sua conta pelo seu identificador. operationId: getProgram parameters: - schema: type: string pattern: ^prog_[0-9A-HJKMNP-TV-Z]{26}$ example: prog_01J9ZK8QF3N2P5R7T9V1W3X5Y7 in: path name: programId required: true description: Identificador do programa (prefixo `prog_` + ULID). responses: '200': description: Default Response content: application/json: schema: type: object properties: id: type: string description: Identificador único do programa (prefixo `prog_` + ULID). example: prog_01J9ZK8QF3N2P5R7T9V1W3X5Y7 organizationId: type: string description: Identificador da organização dona do programa. example: org_01J9ZK8QF3N2P5R7T9V1W3X5Y7 name: type: string description: Nome do programa de afiliados. example: Programa de Indicação Premium currency: type: string description: Moeda do programa (ISO 4217). Atualmente sempre BRL. example: BRL status: type: string enum: - active - paused - archived description: >- Status do programa: `active` (operando), `paused` (suspenso temporariamente) ou `archived` (encerrado permanentemente). example: active approvalMode: type: string enum: - automatic - manual - domain_whitelist description: >- Modo de aprovação de afiliados: `automatic` (aprovação imediata no cadastro), `manual` (operador revisa cada solicitação) ou `domain_whitelist` (aprova automaticamente apenas e-mails de domínios listados). example: manual publicSignupEnabled: type: boolean description: Indica se o cadastro público de afiliados está habilitado. example: false publicSlug: anyOf: - type: string - type: 'null' description: >- Identificador legível da URL pública de inscrição (`kebab(nome)-XXXX`). Gerado automaticamente quando `publicSignupEnabled` é habilitado; `null` quando nunca foi habilitado. Estável — desabilitar não limpa, reabilitar reusa o mesmo slug. A URL de inscrição é `/join/`. example: programa-indique-e-ganhe-a1b2 attributionModel: type: string enum: - first_click - last_click - linear - time_decay - position_based description: >- Modelo de atribuição da conversão entre cliques: `first_click` (primeiro clique), `last_click` (último clique), `linear` (crédito igual entre todos), `time_decay` (mais peso aos cliques recentes) ou `position_based` (mais peso ao primeiro e ao último). example: last_click attributionWindowDays: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Janela de atribuição em dias. example: 30 holdDays: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Período de carência em dias antes da comissão ficar disponível. example: 30 landingUrl: anyOf: - type: string - type: 'null' description: URL de destino padrão dos links do programa. example: https://exemplo.com/promo approvalDomainWhitelist: anyOf: - type: array items: type: string - type: 'null' description: >- Domínios de e-mail aprovados automaticamente no modo `domain_whitelist`. example: - exemplo.com maxLinksPerAffiliate: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Quantidade máxima de links por afiliado. example: 50 couponAttributionPolicy: type: string enum: - coupon_wins - click_wins - split_50_50 description: >- Política de desempate quando a conversão tem cupom E clique atribuído: `coupon_wins` (cupom leva a comissão), `click_wins` (clique leva) ou `split_50_50` (comissão dividida igualmente). example: coupon_wins commissionBasis: type: string enum: - gross - net_of_gateway_fees description: >- Base de cálculo da comissão: `gross` (sobre o valor bruto da venda) ou `net_of_gateway_fees` (sobre o valor líquido, descontadas as taxas do gateway de pagamento). example: gross createdAt: description: Data de criação do programa (ISO-8601). example: '2026-06-13T12:00:00.000Z' type: string format: date-time updatedAt: description: Data da última atualização do programa (ISO-8601). example: '2026-06-13T12:00:00.000Z' type: string format: date-time required: - id - organizationId - name - currency - status - approvalMode - publicSignupEnabled - publicSlug - attributionModel - attributionWindowDays - holdDays - landingUrl - approvalDomainWhitelist - maxLinksPerAffiliate - couponAttributionPolicy - commissionBasis - createdAt - updatedAt 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`. ````