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

# Estado da inscrição

> O que a tela de descadastro do classroom lê, pelo token do link, sem sessão.



## OpenAPI

````yaml GET /v1/email/subscription
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
paths:
  /v1/email/subscription:
    get:
      tags:
        - email
      summary: Se a pessoa do link recebe os e-mails do club
      description: >
        A tela de descadastro do classroom lê isto. Anônima: quem abre é quem

        recebeu o e-mail, sem sessão. O token do link identifica a pessoa e o
        club

        e não expira — um link de descadastro que vence é um e-mail velho sem

        saída —, e é assinado, então não se forja nem se enumera.
      operationId: getEmailSubscription
      parameters:
        - $ref: '#/components/parameters/EmailToken'
      responses:
        '200':
          description: O estado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailSubscriptionResponse'
        '404':
          description: Token inválido (`invalid_token`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '500':
          $ref: '#/components/responses/InternalError'
        '501':
          $ref: '#/components/responses/NotConfigured'
components:
  parameters:
    EmailToken:
      name: token
      in: query
      required: true
      description: |
        O token do link de descadastro, que vem no rodapé e no cabeçalho
        `List-Unsubscribe` de cada e-mail. Assinado e sem prazo.
      schema:
        type: string
        minLength: 1
        maxLength: 128
  schemas:
    EmailSubscriptionResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/EmailSubscription'
    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
    EmailSubscription:
      type: object
      required:
        - club_name
        - status
      properties:
        club_name:
          type: string
        status:
          $ref: '#/components/schemas/EmailSubscriptionStatus'
    EmailSubscriptionStatus:
      type: string
      description: >
        `subscribed` recebe. `unsubscribed` recusou pelo link e pode voltar.

        `complained` marcou como spam e `bounced` teve o endereço recusado de
        vez —

        nenhum dos dois volta por link.
      enum:
        - subscribed
        - unsubscribed
        - complained
        - bounced
  responses:
    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'
    NotConfigured:
      description: |
        O ambiente não tem o que a operação precisa (`not_configured`): o
        provedor de autenticação nas rotas de sessão, o e-mail nas que
        enviam link, a chave de cifra nos webhooks.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'

````

## Related topics

- [Estado da API](/api-reference/health.md)
- [Inscrever aluno](/api-reference/mentorships/attendee-add.md)
- [Mentorias](/essentials/mentorships.md)
- [Descadastrar](/api-reference/email/unsubscribe.md)
- [Números da automação](/api-reference/workflows/stats.md)