> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cakto.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar certificados da área

> Os modelos de certificado da área e o histórico de emissões.

#### Escopo

```bash theme={null}
    read members
```


## OpenAPI

````yaml GET /public_api/members/areas/{member_area_id}/certificates/
openapi: 3.0.3
info:
  title: Cakto API
  version: 1.0.0
  description: Documentação da API pública do Cakto.
servers:
  - url: https://api.cakto.com.br
    description: Cakto API
security: []
paths:
  /public_api/members/areas/{member_area_id}/certificates/:
    get:
      tags:
        - members
      summary: Listar certificados da área
      description: Os modelos de certificado da área e o histórico de emissões.
      operationId: members_areas_certificates_list
      parameters:
        - in: path
          name: member_area_id
          schema:
            type: string
            format: uuid
          description: ID da área de membros.
          required: true
        - name: ordering
          required: false
          in: query
          description: Which field to use when ordering the results.
          schema:
            type: string
        - name: search
          required: false
          in: query
          description: A search term.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MemberAreaCertificatesPanel'
          description: ''
        '401':
          description: Request não autenticado devido à ausência ou invalidez do token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
              examples:
                Token ausente ou inválido:
                  $ref: '#/components/examples/UnauthenticatedErrorExample'
        '404':
          description: Não existe ou não é da sua conta.
      security:
        - OAuth Token: []
components:
  schemas:
    MemberAreaCertificatesPanel:
      type: object
      properties:
        member_area_id:
          type: string
          format: uuid
        updated_at:
          type: string
          format: date-time
        metrics:
          $ref: '#/components/schemas/MemberAreaCertificatesMetrics'
        certificates:
          type: array
          items:
            $ref: '#/components/schemas/MemberAreaCertificate'
        issue_history:
          type: array
          items:
            $ref: '#/components/schemas/MemberAreaCertificateIssueHistory'
        issue_history_total:
          type: integer
      required:
        - certificates
        - issue_history
        - issue_history_total
        - member_area_id
        - metrics
        - updated_at
    UnauthenticatedError:
      type: object
      properties:
        detail:
          type: string
    MemberAreaCertificatesMetrics:
      type: object
      properties:
        total_issued:
          type: integer
        total_issued_growth:
          type: integer
        completion_rate:
          type: integer
        completion_rate_growth:
          type: integer
        pending_validations:
          type: integer
      required:
        - completion_rate
        - completion_rate_growth
        - pending_validations
        - total_issued
        - total_issued_growth
    MemberAreaCertificate:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: Identificador único do certificado no sistema
        public_id:
          type: string
          readOnly: true
          title: ID Público
          description: Código público do certificado, não sequencial
        name:
          type: string
          title: Nome
          description: Nome do certificado exibido no painel do produtor
          maxLength: 255
        status:
          allOf:
            - $ref: '#/components/schemas/MemberAreaCertificateStatusEnum'
          description: |-
            Status atual do certificado

            * `draft` - Rascunho
            * `active` - Ativo
            * `inactive` - Inativo
            * `manual-review` - Revisão manual
            * `deleted` - Excluído
        emission_type:
          allOf:
            - $ref: '#/components/schemas/EmissionTypeEnum'
          title: Tipo de Emissão
          description: >-
            Se o certificado é emitido automaticamente pelo gatilho ou
            manualmente pelo produtor


            * `automatic` - Automática

            * `manual` - Manual
        trigger_type:
          allOf:
            - $ref: '#/components/schemas/TriggerTypeEnum'
          title: Tipo de Gatilho
          description: |-
            Condição que dispara a emissão do certificado

            * `course-completion` - Conclusão de curso
            * `manual-issue` - Emissão manual
        trigger_label:
          type: string
          title: Rótulo do Gatilho
          description: Texto exibido no painel para o gatilho do certificado
          maxLength: 255
        trigger_rules: {}
        text:
          type: string
          nullable: true
          maxLength: 5000
        course_title:
          type: string
          nullable: true
          maxLength: 255
        theme:
          allOf:
            - $ref: '#/components/schemas/ThemeEnum'
          title: Tema
          description: |-
            Tema visual do certificado

            * `white` - Claro
            * `dark` - Escuro
        font_family:
          type: string
          title: Fonte
          description: Família da fonte usada no certificado
          maxLength: 100
        primary_color:
          type: string
          title: Cor Principal
          description: >-
            Cor principal do certificado no formato hexadecimal #RRGGBB ou
            #RRGGBBAA
          pattern: ^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$
          maxLength: 9
        logomark_url:
          type: string
          nullable: true
          maxLength: 1024
        use_logo_as_watermark:
          type: boolean
          title: Logo como Marca D'água
          description: Indica se o logo também é usado como marca d'água
        show_cactus_pattern:
          type: boolean
          title: Padrão de Cactos
          description: Indica se o padrão de cactos aparece no cabeçalho do certificado
        include_signature:
          type: boolean
          title: Incluir Assinatura
          description: Indica se o certificado exibe a assinatura
        signature_url:
          type: string
          nullable: true
          maxLength: 1024
        signer_name:
          type: string
          nullable: true
          maxLength: 255
        signer_initials:
          type: string
          nullable: true
          maxLength: 20
        signer_role:
          type: string
          nullable: true
          maxLength: 255
        issued_count:
          type: integer
          readOnly: true
        member_area_section:
          type: string
          format: uuid
          nullable: true
        member_area_section_type:
          type: string
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Criado em
          description: Data de criação do certificado
        updated_at:
          type: string
          format: date-time
          readOnly: true
          title: Atualizado em
          description: Data de atualização do certificado
      required:
        - created_at
        - id
        - issued_count
        - member_area_section_type
        - name
        - public_id
        - updated_at
    MemberAreaCertificateIssueHistory:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: Identificador único da emissão no sistema
        public_id:
          type: string
          readOnly: true
          title: ID Público
          description: >-
            Código que a verificação pública do certificado recebe, não
            sequencial
        certificate_id:
          type: string
          format: uuid
          readOnly: true
        certificate_name:
          type: string
          readOnly: true
        certificate_public_id:
          type: string
          readOnly: true
        student_name:
          type: string
          readOnly: true
          title: Nome do Aluno
          description: Nome do aluno congelado no momento da emissão
        student_email:
          type: string
          format: email
          readOnly: true
          title: E-mail do Aluno
          description: E-mail do aluno congelado no momento da emissão
        source:
          allOf:
            - $ref: '#/components/schemas/SourceA1cEnum'
          readOnly: true
          title: Origem
          description: |-
            Se a emissão foi automática, pelo gatilho, ou manual, pelo produtor

            * `automatic` - Automática
            * `manual` - Manual
        issued_at:
          type: string
          format: date-time
          readOnly: true
          title: Emitido em
          description: Data e hora da emissão do certificado
      required:
        - certificate_id
        - certificate_name
        - certificate_public_id
        - id
        - issued_at
        - public_id
        - source
        - student_email
        - student_name
    MemberAreaCertificateStatusEnum:
      enum:
        - draft
        - active
        - inactive
        - manual-review
        - deleted
      type: string
      description: |-
        * `draft` - Rascunho
        * `active` - Ativo
        * `inactive` - Inativo
        * `manual-review` - Revisão manual
        * `deleted` - Excluído
    EmissionTypeEnum:
      enum:
        - automatic
        - manual
      type: string
      description: |-
        * `automatic` - Automática
        * `manual` - Manual
    TriggerTypeEnum:
      enum:
        - course-completion
        - manual-issue
      type: string
      description: |-
        * `course-completion` - Conclusão de curso
        * `manual-issue` - Emissão manual
    ThemeEnum:
      enum:
        - white
        - dark
      type: string
      description: |-
        * `white` - Claro
        * `dark` - Escuro
    SourceA1cEnum:
      enum:
        - automatic
        - manual
      type: string
      description: |-
        * `automatic` - Automática
        * `manual` - Manual
  examples:
    UnauthenticatedErrorExample:
      summary: Token ausente ou inválido
      description: Token ausente ou inválido
      value:
        detail: As credenciais de autenticação não foram fornecidas.
  securitySchemes:
    OAuth Token:
      type: http
      scheme: bearer
      in: header
      name: Authorization
      description: >-
        Token de autenticação do tipo `Bearer {access_token}`, onde
        `{access_token}` é o token obtido no fluxo de
        [autenticação](/authentication).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.