> ## 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. # Listar certificados > Os certificados emitidos pelo club, com recorte por curso, por aluno e por estado. O `q` procura em nome, e-mail e no **código** — digitado como está impresso (em grupos de quatro) ou corrido. É como achar o certificado que um aluno mandou para o suporte. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/certificates 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}/certificates: parameters: - $ref: '#/components/parameters/OrgId' get: tags: - certificates summary: Os certificados emitidos pelo club description: | Do mais novo para o mais antigo. O recorte é por curso, por aluno, por estado de revogação e por busca — o `q` procura em nome, e-mail e no CÓDIGO (digitado com ou sem os separadores). O `total` é o do recorte. Exige permissão de administração do club. operationId: listCertificates parameters: - name: q in: query required: false schema: type: string maxLength: 120 - name: course_id in: query required: false schema: type: string format: uuid - name: student_id in: query required: false schema: type: string format: uuid - name: revoked in: query required: false description: Ausente traz os dois. schema: type: boolean - 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/CertificateList' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '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 schemas: CertificateList: type: object required: - data - total properties: data: type: array items: $ref: '#/components/schemas/Certificate' total: type: integer description: O total do RECORTE, não da página. Certificate: type: object required: - id - code - code_formatted - student_id - student_name - student_email - course_id - course_title - course_public_id - club_name - lesson_count - version - issued_at - completed_at - revoked - verify_url description: | Um certificado emitido. Os campos que ele imprime são um INSTANTÂNEO da emissão: o nome de quem concluiu, o título do curso, o nome do club e a carga horária são os do dia em que ele saiu, e o curso que mudar depois não reescreve o que está na parede de alguém. Recopiar é `reissue`, explícito, e sobe a `version`. properties: id: type: string format: uuid code: type: string description: O código canônico, sem separadores. code_formatted: type: string description: O código como ele é impresso, em grupos de quatro. student_id: type: string format: uuid student_name: type: string description: O nome no INSTANTÂNEO, que pode diferir do nome atual da conta. student_email: type: string description: O e-mail ATUAL da conta — ele não é impresso no certificado. course_id: type: string format: uuid course_title: type: string course_public_id: type: string club_name: type: string hours: type: integer nullable: true lesson_count: type: integer description: Quantas aulas contavam no curso quando o certificado saiu. version: type: integer minimum: 1 description: Sobe a cada reemissão. 1 é o original. issued_at: type: string format: date-time completed_at: type: string format: date-time description: | Quando o curso foi concluído. Igual à emissão quando ela é imediata, e anterior a ela em quem concluiu antes de o club ligar o certificado. revoked: type: boolean revoked_at: type: string format: date-time nullable: true revoked_reason: type: string nullable: true verify_url: type: string description: O endereço público de verificação, o mesmo impresso no PDF. 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' 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 - [Listar alunos](/api-reference/students/list.md) - [Listar entregas](/api-reference/catalog/deliveries-list.md) - [Listar cursos](/api-reference/content/courses-list.md) - [Listar playbooks](/api-reference/mentorships/playbooks-list.md) - [Listar canais](/api-reference/lives/live-channels-list.md)