> ## 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.

# Club de um endereço

> Nome e slug do club que atende num subdomínio. Anônima: é o que as telas de entrada do classroom leem antes de existir sessão.



## OpenAPI

````yaml GET /v1/clubs/by-slug/{slug}
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/clubs/by-slug/{slug}:
    get:
      tags:
        - clubs
      summary: O club de um endereço do classroom
      description: |
        O que as telas de ENTRADA do classroom precisam saber antes de existir
        sessão: como o club se chama.

        É anônima porque tem que ser — quem abre `<club>.weve.studio/sign-in`
        ainda não tem credencial nenhuma, e o nome é o que diz à pessoa que ela
        chegou no lugar certo. Não vaza nada que o endereço já não entregue:
        quem visita o subdomínio vê a mesma coisa.

        Devolve só a vitrine (nome e slug), NUNCA o id nem as datas — nada aqui
        serve para agir sobre o club, e o `{clubId}` das rotas escopadas não sai
        por este caminho.
      operationId: getClubBySlug
      parameters:
        - name: slug
          in: path
          required: true
          description: O subdomínio em que o classroom atende.
          schema:
            type: string
            maxLength: 63
      responses:
        '200':
          description: O club daquele endereço
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicClubResponse'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    PublicClubResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/PublicClub'
    PublicClub:
      type: object
      description: |
        O club como quem ainda não entrou o vê. Deliberadamente magro: nome e
        endereço, nada com que se possa agir.
      required:
        - slug
      properties:
        slug:
          type: string
        name:
          type: string
          description: Ausente enquanto ninguém o informou — a tela cai no slug.
    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'
    TooManyRequests:
      description: Teto por IP atingido
      headers:
        Retry-After:
          schema:
            type: integer
      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

- [Nome e endereço do club](/api-reference/clubs/update.md)
- [Criar club](/api-reference/clubs/create.md)
- [Biblioteca de mídia](/essentials/media.md)
- [A biblioteca do club](/api-reference/media/list.md)
- [Club da sessão](/api-reference/clubs/get.md)