> ## 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. # Turmas de uma entrega > Lista as turmas, com quantas pessoas estão em cada uma e o bônus. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/deliveries/{deliveryId}/cohorts 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: sales-platforms - name: catalog - name: content - name: classroom - name: students - name: auth paths: /v1/clubs/{clubId}/deliveries/{deliveryId}/cohorts: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/DeliveryId' get: tags: - catalog summary: Turmas de uma entrega description: | Da mais recente para a mais antiga, inclusive arquivadas. Cada uma com quantas pessoas estão nela agora (matrícula ativa na entrega da turma) e o bônus que abre. operationId: listCohorts responses: '200': description: As turmas da entrega content: application/json: schema: $ref: '#/components/schemas/CohortList' '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 DeliveryId: name: deliveryId in: path required: true schema: type: string format: uuid schemas: CohortList: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/Cohort' Cohort: type: object required: - id - delivery_id - name - admission - offers - starts_at - ends_at - access - bonus_deliveries - enrolled_count - member_count - archived - created_at properties: id: type: string format: uuid delivery_id: type: string format: uuid name: type: string admission: $ref: '#/components/schemas/CohortAdmission' enrolls_from: type: string format: date-time description: Só na admissão por janela. enrolls_until: type: string format: date-time offers: type: array items: $ref: '#/components/schemas/CohortOffer' description: Só na admissão por oferta. starts_at: type: string format: date-time ends_at: type: string format: date-time access: $ref: '#/components/schemas/CohortAccess' access_days: type: integer bonus_deliveries: type: array items: $ref: '#/components/schemas/CohortBonus' enrolled_count: type: integer description: >- Quantas pessoas têm matrícula ATIVA na entrega da turma — quem tem acesso agora. member_count: type: integer description: | Quantas pessoas passaram pela turma e não foram revogadas, inclusive as que já expiraram. É o número que a turma encerrada mostra. archived: type: boolean created_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 CohortAdmission: type: string enum: - window - offer description: | Como se entra na turma. `window`: pela data de pagamento, dentro da janela de matrícula. `offer`: pelos códigos de oferta reivindicados, sem janela — é o que permite turmas simultâneas. CohortOffer: type: object required: - connection_id - external_offer_id properties: connection_id: type: string format: uuid description: A conexão com a plataforma que emitiu o código. external_offer_id: type: string minLength: 1 maxLength: 200 CohortAccess: type: string enum: - lifetime - until_end - days_from_start - days_from_enrollment description: | Como a janela de acesso de quem entra é calculada. `until_end` vai até `ends_at`; `days_from_start` conta `access_days` de `starts_at`; `days_from_enrollment` conta de quando a pessoa entrou. CohortBonus: type: object required: - delivery_id properties: delivery_id: type: string format: uuid delivery_name: type: string readOnly: true access_days: type: integer minimum: 1 description: | Prazo próprio do bônus, em dias a partir da entrada na turma. Ausente é a mesma janela da turma. 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 - [Criar turma](/api-reference/catalog/cohorts-create.md) - [Conceder entrega](/api-reference/students/grant.md) - [Mudar de turma](/api-reference/students/move.md) - [Reaplicar turma](/api-reference/catalog/cohorts-reapply.md) - [Revogar a turma](/api-reference/catalog/cohorts-revoke.md)