> ## 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 do endereço inteiro

> A mesma vitrine da rota por slug, alcançada pelo host como o browser o vê — domínio próprio ou `<slug>.weve.studio`. Anônima, e o classroom deixa de saber qual é o caso.



## OpenAPI

````yaml GET /v1/clubs/by-host/{host}
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: outgoing-webhooks
  - name: sales-platforms
  - name: catalog
  - name: content
  - name: classroom
  - name: community
  - name: mentorships
  - name: agents
  - name: lives
  - name: students
  - name: auth
  - name: campaigns
  - name: workflows
  - name: email
  - name: exports
  - name: certificates
paths:
  /v1/clubs/by-host/{host}:
    get:
      tags:
        - clubs
      summary: O club que atende num endereço
      description: |
        A mesma vitrine da rota por slug, alcançada pelo endereço INTEIRO — é o
        que as telas de entrada do classroom perguntam quando o club atende num
        domínio próprio (`cursos.escola.com.br`), onde não há slug para ler.

        Resolve as duas formas: o domínio próprio cadastrado pelo club e o
        `<slug>.weve.studio` de sempre, de onde o slug é extraído. O classroom
        pode mandar `location.host` e parar de saber qual é o caso.

        O domínio próprio responde MESMO ANTES de a verificação ter passado:
        quem chegou por aquele host já provou o apontamento melhor do que
        qualquer conferência nossa — o DNS do club mandou a requisição para cá.

        Anônima, como a rota por slug, e pela mesma razão: quem abre a tela de
        entrada ainda não tem credencial nenhuma. Devolve só nome, slug e cor.
      operationId: getClubByHost
      parameters:
        - name: host
          in: path
          required: true
          description: |
            O endereço como chegou no browser, sem protocolo e sem porta
            (`cursos.escola.com.br`, `escola.weve.studio`).
          schema:
            type: string
            maxLength: 253
      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.
        accent_color:
          $ref: '#/components/schemas/AccentColor'
    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
    AccentColor:
      type: string
      pattern: ^#[0-9a-fA-F]{6}$
      description: |
        A cor do club no classroom (botões e progresso), em hex de seis
        dígitos. Gravada em minúscula. Ausente, o classroom usa a dele.
      example: '#1d63d1'
  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)
- [Campanhas e automações](/essentials/campaigns-and-workflows.md)
- [A biblioteca do club](/api-reference/media/list.md)
- [Club de um endereço](/api-reference/clubs/by-slug.md)
- [Disponibilidade de endereço](/api-reference/clubs/slug-availability.md)