> ## 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. # E-mails de um aluno > Cada e-mail de campanha, automação ou aviso de live mandado para a pessoa, com o que aconteceu com ele. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/students/{studentId}/emails 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/{clubId}/students/{studentId}/emails: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/StudentId' get: tags: - students summary: Os e-mails que o club mandou para o aluno description: | Cada e-mail de campanha, de automação ou de aviso de live endereçado a esta pessoa, do mais novo para o mais antigo, com o que aconteceu com ele: enviado, pulado (e por quê), aberto, clicado, devolvido. É a resposta para "por que ela não recebe nada?" — junto com `email_suppression`, no resumo da conta. Os e-mails de conta (link de acesso, código, confirmação) não entram: não passam pela fila de envio do club. Exige permissão de administração do club. operationId: listStudentEmails parameters: - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 25 - name: page in: query required: false schema: type: integer minimum: 1 default: 1 responses: '200': description: A página pedida content: application/json: schema: $ref: '#/components/schemas/StudentEmailList' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalError' security: - userSession: [] components: parameters: OrgId: name: clubId in: path required: true description: > Id público da organização — o mesmo que `GET /v1/me` devolve em `organization_id`. Na URL o recurso se chama **club**; no contrato e no domínio, organization. A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o que as pessoas leem. É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer. O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso. schema: type: string format: uuid StudentId: name: studentId in: path required: true schema: type: string format: uuid schemas: StudentEmailList: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/StudentEmail' total: type: integer StudentEmail: description: Um e-mail do club para o aluno, com o que aconteceu com ele. type: object required: - id - source - source_name - status - created_at properties: id: type: string format: uuid source: description: De onde ele saiu. type: string enum: - campaign - automation - live source_id: description: A campanha, a automação ou a live. Ausente quando ela foi apagada. type: string format: uuid source_name: description: O nome da campanha, da automação ou o título da live. type: string status: type: string enum: - pending - sending - sent - skipped - failed skip_reason: description: >- Por que foi pulado, quando `status` é `skipped` — o código da fila de envio. type: string created_at: type: string format: date-time sent_at: type: string format: date-time delivered_at: type: string format: date-time opened_at: type: string format: date-time clicked_at: type: string format: date-time bounced_at: type: string format: date-time complained_at: type: string format: date-time 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: Unauthorized: description: Sessão ausente, expirada ou revogada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: > A sessão é válida, mas não age nesta organização. É a mesma resposta para uma organização que não existe — distinguir as duas deixaria enumerar organizações alheias. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' 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' securitySchemes: userSession: type: http scheme: bearer description: | Token OPACO de sessão de quem administra, emitido por `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo desenho do `studentSession`, para a outra identidade. É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o `studentSession`; uma rota consumida pelos dois declara os dois esquemas, e o middleware aceita qualquer um deles. As duas credenciais são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em que cada uma existe. O dashboard o guarda em cookie httpOnly, que o BFF troca pelo `Authorization` a cada chamada. ```` ## Related topics - [Aviso do provedor de e-mail](/api-reference/email/webhook.md) - [Confirmar e-mail](/api-reference/auth/verify-email.md) - [Corrigir aluno](/api-reference/students/update.md) - [Pré-visualizar e-mail do passo](/api-reference/workflows/email-preview.md)