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

# Pedir uma exportação

> Põe o arquivo na fila: alunos, matrículas, compras, assinaturas, progresso ou tudo num .zip.

A resposta chega na hora, com a exportação em `pending`. O arquivo é gerado em segundo plano:
consulte a exportação até `status` ser `ready` e então peça o download.

```bash theme={null}
curl -X POST https://api.weve.cx/v1/clubs/$CLUB_ID/exports \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"kind": "purchases", "format": "xlsx", "filters": {"status": "paid", "from": "2026-01-01", "to": "2026-01-31"}}'
```


## OpenAPI

````yaml POST /v1/clubs/{clubId}/exports
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
paths:
  /v1/clubs/{clubId}/exports:
    parameters:
      - $ref: '#/components/parameters/OrgId'
    post:
      tags:
        - exports
      summary: Pede uma exportação
      description: |
        Põe o arquivo na fila e responde na hora, com a exportação em `pending`.
        O arquivo é gerado em segundo plano, em lotes; acompanhe por
        `GET .../exports/{exportId}` (`rows_done` de `rows_total`) e baixe por
        `.../download` quando estiver `ready`. Quem pediu recebe um e-mail
        quando o arquivo fica pronto — ou quando falha.

        O mesmo pedido (tipo, formato e filtros) repetido em até cinco minutos
        devolve a exportação que já existe, em vez de gerar outra.

        - `kind` `full` é a exportação completa: um `.zip` com um arquivo por
          tipo, sem filtros, no formato pedido.
        - O CSV sai em UTF-8 com BOM, separado por ponto e vírgula e com valores
          no formato brasileiro — abre direto no Excel em português. Texto que
          começa com `=`, `+`, `-` ou `@` ganha um apóstrofo na frente, para não
          virar fórmula.
        - O XLSX tem o limite de linhas do Excel (1.048.575); acima disso a
          exportação falha pedindo CSV.
        - O CPF do aluno sai no arquivo; o de aluno removido, nunca.

        Até 3 exportações em andamento por club. Exige permissão de
        administração do club.

        Erros: `invalid_kind`, `invalid_format` e `invalid_filter` (422);
        `too_many_exports` (409); `not_configured` (501, ambiente sem o
        armazenamento de arquivos).
      operationId: createExport
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportCreate'
      responses:
        '202':
          description: Na fila — ou o pedido idêntico que já estava lá
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '501':
          $ref: '#/components/responses/NotConfigured'
      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
  schemas:
    ExportCreate:
      type: object
      required:
        - kind
      properties:
        kind:
          $ref: '#/components/schemas/ExportKind'
        format:
          allOf:
            - $ref: '#/components/schemas/ExportFormat'
          description: '`csv` quando ausente.'
        filters:
          $ref: '#/components/schemas/ExportFilters'
    ExportResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/Export'
    ExportKind:
      type: string
      description: |
        O que exportar. `full` é a exportação completa, um `.zip` com todos os
        outros tipos.
      enum:
        - full
        - students
        - enrollments
        - purchases
        - subscriptions
        - course_progress
    ExportFormat:
      type: string
      enum:
        - csv
        - xlsx
    ExportFilters:
      type: object
      description: |
        Os filtros do pedido. Cada tipo aceita os seus (ver
        `GET .../export-kinds`); mandar outro é `invalid_filter`. As datas são
        dias no fuso de São Paulo, com as duas pontas incluídas.
      properties:
        from:
          type: string
          format: date
        to:
          type: string
          format: date
        status:
          type: string
          description: Um dos valores que o tipo lista para `status`.
        access:
          type: string
          enum:
            - active
            - none
          description: Alunos com ou sem matrícula ativa.
        product_id:
          type: string
          format: uuid
        delivery_id:
          type: string
          format: uuid
        course_id:
          type: string
          format: uuid
    Export:
      type: object
      required:
        - id
        - kind
        - format
        - filters
        - status
        - rows_total
        - rows_done
        - size_bytes
        - file_name
        - error
        - requested_by
        - download_count
        - created_at
        - started_at
        - finished_at
        - expires_at
      properties:
        id:
          type: string
          format: uuid
        kind:
          $ref: '#/components/schemas/ExportKind'
        format:
          $ref: '#/components/schemas/ExportFormat'
        filters:
          $ref: '#/components/schemas/ExportFilters'
        status:
          $ref: '#/components/schemas/ExportStatus'
        rows_total:
          type: integer
          format: int64
          nullable: true
          description: |
            Quantas linhas o arquivo terá. Nulo antes de a geração começar, e
            enquanto gera um tipo que não sabe contar antes (`course_progress`).
        rows_done:
          type: integer
          format: int64
        size_bytes:
          type: integer
          format: int64
          nullable: true
        file_name:
          type: string
          nullable: true
          description: O nome com que o arquivo é salvo.
        error:
          type: string
          nullable: true
          description: Por que falhou, em português.
        requested_by:
          allOf:
            - $ref: '#/components/schemas/ExportRequester'
          nullable: true
          description: Quem pediu. Nulo se a conta foi excluída.
        download_count:
          type: integer
        created_at:
          type: string
          format: date-time
        started_at:
          type: string
          format: date-time
          nullable: true
        finished_at:
          type: string
          format: date-time
          nullable: true
        expires_at:
          type: string
          format: date-time
          nullable: true
          description: Até quando o arquivo pode ser baixado.
    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
    ExportStatus:
      type: string
      description: |
        `pending` na fila; `running` sendo gerada; `ready` para baixar;
        `failed` com o motivo em `error`; `expired` quando o arquivo já saiu do
        armazenamento.
      enum:
        - pending
        - running
        - ready
        - failed
        - expired
    ExportRequester:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
  responses:
    BadRequest:
      description: Requisição malformada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    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'
    Conflict:
      description: >-
        Conflito com o estado atual. O `code` diz qual; a descrição da operação
        lista os possíveis.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    UnprocessableEntity:
      description: Campos obrigatórios ausentes ou inválidos
      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'
    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'
  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

- [Consultar uma exportação](/api-reference/exports/get.md)
- [Tipos de exportação](/api-reference/exports/kinds.md)
- [Listar exportações](/api-reference/exports/list.md)
- [Pedir redefinição](/api-reference/auth/forgot-password.md)
- [Pedir código de entrada](/api-reference/account/login-code.md)