> ## 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 domínios personalizados da organização

> Lista os domínios próprios da organização, com o estado de verificação de DNS e de TLS. Filtra por tipo com `?kind=link|portal`.



## OpenAPI

````yaml /openapi.json get /settings/custom-domains
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:
  /settings/custom-domains:
    get:
      tags:
        - Settings
      summary: Lista os domínios personalizados da organização
      description: >-
        Lista os domínios próprios da organização, com o estado de verificação
        de DNS e de TLS. Filtra por tipo com `?kind=link|portal`.
      operationId: listCustomDomains
      parameters:
        - schema:
            type: string
            enum:
              - link
              - portal
          in: query
          name: kind
          required: false
          description: Filtra por tipo de domínio. Omitido lista todos.
      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 domínio (prefixo `cdom_`).
                          example: cdom_01J9Z3K7Qn8vYwT2bX4cE6dF8g
                        organizationId:
                          type: string
                          description: Identificador da organização dona do domínio.
                          example: org_01J9Z3K7Qn8vYwT2bX4cE6dF8g
                        hostname:
                          type: string
                          description: 'Domínio próprio (ex.: `go.cliente.com`).'
                          example: go.cliente.com
                        kind:
                          type: string
                          enum:
                            - link
                            - portal
                          description: >-
                            O que o domínio serve: `link` (links `/t/{token}`)
                            ou `portal` (portal whitelabel no domínio do
                            cliente).
                          example: link
                        status:
                          type: string
                          enum:
                            - pending
                            - verifying
                            - verified
                            - failed
                          description: >-
                            Verificação de posse via DNS. `verified` é
                            pré-requisito para servir tráfego e para virar
                            primário.
                          example: pending
                        tlsStatus:
                          type: string
                          enum:
                            - pending
                            - issued
                            - failed
                          description: >-
                            Estado do certificado TLS (Caddy on-demand
                            provisiona sob demanda).
                          example: pending
                        isPrimary:
                          type: boolean
                          description: >-
                            Indica se é o domínio padrão da org para novos links
                            (no máx. 1).
                        verificationToken:
                          type: string
                          description: >-
                            Valor a publicar no registro TXT
                            `_repass.<hostname>` para provar a posse do domínio.
                            Não é segredo.
                          example: cdom_verify_01J9Z3K7Qn8vYwT2bX4cE6dF8g
                        verifiedAt:
                          anyOf:
                            - type: string
                              format: date-time
                            - type: 'null'
                          description: >-
                            Data/hora (ISO-8601) da verificação de DNS, ou
                            `null`.
                        tlsIssuedAt:
                          anyOf:
                            - type: string
                              format: date-time
                            - type: 'null'
                          description: >-
                            Data/hora (ISO-8601) da emissão do certificado, ou
                            `null`.
                        createdAt:
                          description: Data/hora (ISO-8601) de criação.
                          type: string
                          format: date-time
                        updatedAt:
                          description: Data/hora (ISO-8601) da última atualização.
                          type: string
                          format: date-time
                      required:
                        - id
                        - organizationId
                        - hostname
                        - kind
                        - status
                        - tlsStatus
                        - isPrimary
                        - verificationToken
                        - verifiedAt
                        - tlsIssuedAt
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                required:
                  - data
                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`.

````