> ## Documentation Index
> Fetch the complete documentation index at: https://docs.weve.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Vitrine do link de cadastro

> O que a página de cadastro mostra antes do formulário.



## OpenAPI

````yaml GET /v1/auth/registration-links/{code}
openapi: 3.0.3
info:
  title: weve API
  description: >
    Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de
    verdade**:

    os tipos e a interface de servidor em Go, e o client TypeScript, são todos

    gerados daqui (`make openapi`). Handler que divergir da interface não
    compila.


    A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de

    máquina, protegido por segredo dedicado, e não é contrato de cliente.
  version: 0.2.0
servers:
  - url: https://api.weve.cx
    description: produção
  - url: http://localhost:8080
    description: desenvolvimento
security: []
tags:
  - name: health
  - name: session
  - name: account
  - name: clubs
  - name: members
  - name: webhooks
  - name: sales-platforms
  - name: catalog
  - name: content
  - name: classroom
  - name: students
  - name: auth
paths:
  /v1/auth/registration-links/{code}:
    parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 64
      - name: club
        in: query
        required: true
        description: O slug do club, o mesmo subdomínio de onde a página foi servida.
        schema:
          type: string
    get:
      tags:
        - auth
      summary: A vitrine de um link de cadastro
      description: |
        O que a página de cadastro mostra antes do formulário: o nome do
        club, o nome do link e o que ele abre. Anônima. Link desligado ou
        inexistente responde 404, sem distinguir os dois.
      operationId: getRegistrationLink
      responses:
        '200':
          description: O link
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationLinkPublicResponse'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    RegistrationLinkPublicResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/RegistrationLinkPublic'
    RegistrationLinkPublic:
      type: object
      required:
        - club_name
        - name
        - deliveries
      properties:
        club_name:
          type: string
        name:
          type: string
        deliveries:
          type: array
          items:
            type: string
          description: Os nomes do que o link abre.
    ErrorEnvelope:
      type: object
      description: >-
        Envelope único de erro da API. O `code` é o contrato com o cliente — a
        `message` é diagnóstico, e pode mudar.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
          properties:
            code:
              type: string
            message:
              type: string
  responses:
    NotFound:
      description: Recurso não encontrado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: >-
        Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no
        rastreamento.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'

````

## Related topics

- [Links de cadastro](/api-reference/registration-links/list.md)
- [Criar link de cadastro](/api-reference/registration-links/create.md)
- [Alterar link de cadastro](/api-reference/registration-links/update.md)
- [Cadastro por link](/api-reference/auth/register-by-link.md)
- [Trocar o código](/api-reference/registration-links/rotate.md)