> ## 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. # Tipos de exportação > O catálogo do que dá para exportar: colunas de cada arquivo e os filtros que cada tipo aceita. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/export-kinds 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}/export-kinds: parameters: - $ref: '#/components/parameters/OrgId' get: tags: - exports summary: Os tipos de exportação description: | O catálogo do que dá para exportar: o nome de cada tipo, as colunas do arquivo e os filtros que ele aceita — com os valores de cada filtro de escolha. A tela monta o formulário daqui, e um filtro que não está na lista do tipo é recusado no pedido (`invalid_filter`), nunca ignorado. Exige permissão de administração do club. operationId: listExportKinds responses: '200': description: Os tipos, na ordem da tela content: application/json: schema: $ref: '#/components/schemas/ExportKindList' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' 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: ExportKindList: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/ExportKindInfo' ExportKindInfo: type: object required: - kind - label - description - period_label - filters - columns - includes properties: kind: $ref: '#/components/schemas/ExportKind' label: type: string description: type: string period_label: type: string nullable: true description: Qual data o período filtra ("Pagamento", "Cadastro"). filters: type: array items: $ref: '#/components/schemas/ExportFilterInfo' columns: type: array description: As colunas do arquivo, na ordem. Vazio na exportação completa. items: type: string includes: type: array description: Os tipos que a exportação completa junta. Vazio nos outros. items: $ref: '#/components/schemas/ExportKind' 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 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 ExportFilterInfo: type: object required: - name - options properties: name: $ref: '#/components/schemas/ExportFilterName' options: type: array description: Os valores aceitos, para `status` e `access`. Vazio nos outros. items: $ref: '#/components/schemas/ExportFilterOption' ExportFilterName: type: string description: '`period` é o par `from`/`to`.' enum: - period - status - access - product_id - delivery_id - course_id ExportFilterOption: type: object required: - value - label properties: value: type: string label: 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' 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 - [Pedir uma exportação](/api-reference/exports/create.md) - [Consultar uma exportação](/api-reference/exports/get.md) - [Listar exportações](/api-reference/exports/list.md) - [Webhooks de saída](/essentials/webhooks.md) - [access.*](/api-reference/webhook-events/access.md)