> ## 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 áreas de membros

> As áreas de membros (Members V3) dos seus produtos.

#### Escopo

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


## OpenAPI

````yaml GET /public_api/members/areas/
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/:
    get:
      tags:
        - members
      summary: Listar áreas de membros
      description: >-
        As áreas de membros (Members V3) dos seus produtos. Cada produto com a
        entrega "Cakto Members V3" tem uma área; o `id` dela é o ponto de
        partida das outras rotas. Para ver a estrutura inteira de uma vez, use a
        árvore de conteúdo.
      operationId: members_areas_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Número de resultados a serem retornados por página.
          schema:
            type: integer
        - name: ordering
          required: false
          in: query
          description: Which field to use when ordering the results.
          schema:
            type: string
        - name: page
          required: false
          in: query
          description: Número da página a ser retornada.
          schema:
            type: integer
        - in: query
          name: product
          schema:
            type: string
          description: Só a área deste produto.
        - name: search
          required: false
          in: query
          description: A search term.
          schema:
            type: string
        - in: query
          name: status
          schema:
            type: string
            enum:
              - draft
              - published
          description: '`draft` (rascunho) ou `published` (publicada).'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedMemberAreasList'
          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'
      security:
        - OAuth Token: []
components:
  schemas:
    PaginatedMemberAreasList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/MemberAreas'
    UnauthenticatedError:
      type: object
      properties:
        detail:
          type: string
    MemberAreas:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: Identificador único da área de membros
        slug:
          type: string
          nullable: true
          maxLength: 255
        status:
          allOf:
            - $ref: '#/components/schemas/StatusA90Enum'
          description: |-
            Status atual da área de membros

            * `draft` - Rascunho
            * `published` - Publicado
            * `deleted` - Excluído
        name:
          type: string
          title: Nome
          description: Nome da área de membros
          maxLength: 255
        description:
          type: string
          title: Descrição
          description: Descrição da área de membros
        product:
          type: string
          description: Produto desta área de membros
          readOnly: true
          title: Produto
        comments_enabled:
          type: boolean
          title: Comentários Habilitados
          description: Indica se os comentários estão habilitados na área de membros
        always_show_showcase:
          type: boolean
          title: Sempre Exibir a Vitrine
          description: >-
            Indica se a vitrine é exibida mesmo quando o produto tem um curso
            único
        single_card_in_student_list:
          type: boolean
          title: Área em Card Único na Lista do Aluno
          description: >-
            Indica se o aluno vê a área como um card só na lista de cursos, em
            vez de um card por curso
        show_students_count:
          type: boolean
          title: Exibir Total de Alunos
          description: Indica se o total de alunos da área de membros é exibido ao aluno
        show_free_lessons_row:
          type: boolean
          title: Exibir Aulas Gratuitas no Topo
          description: >-
            Indica se a vitrine mostra no topo as aulas gratuitas do conteúdo
            pago
        public_showcase:
          type: boolean
          title: Vitrine Pública
          description: Indica se a vitrine da área é servida a quem ainda não é aluno
        logo:
          type: string
          format: uri
          readOnly: true
          nullable: true
          description: Logo da área de membros
        logo_original:
          type: string
          format: uri
          readOnly: true
          nullable: true
          description: Logo da área de membros antes do corte, base para novos cortes
        banner:
          type: string
          format: uri
          readOnly: true
          nullable: true
          description: Banner da área de membros
        banner_original:
          type: string
          format: uri
          readOnly: true
          nullable: true
          description: Banner da área de membros antes do corte, base para novos cortes
        banner_mobile:
          type: string
          format: uri
          readOnly: true
          nullable: true
          description: Banner da home da área de membros para o celular, em 3:2
        banner_mobile_original:
          type: string
          format: uri
          readOnly: true
          nullable: true
          description: >-
            Banner mobile da área de membros antes do corte, base para novos
            cortes
        hero_title:
          type: string
          title: Título Hero
          description: Título da seção hero da área de membros
          maxLength: 255
        hero_description:
          type: string
          title: Descrição Hero
          description: Descrição da seção hero da área de membros
        hero_cta_label:
          type: string
          title: Label do CTA
          description: Label do botão de call to action da seção hero
          maxLength: 255
        hero_cta_section:
          type: string
          format: uuid
          nullable: true
        hero_cta_url:
          type: string
          writeOnly: true
          nullable: true
        title_font_family:
          type: string
          nullable: true
          title: Fonte do Título
          description: Fonte do título e do subtítulo da seção hero
          maxLength: 100
        title_color:
          type: string
          nullable: true
          title: Cor do Título
          description: 'Cor do título da seção hero, em hexadecimal (#RRGGBB ou #RRGGBBAA)'
          pattern: ^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$
          maxLength: 9
        subtitle_color:
          type: string
          nullable: true
          title: Cor do Subtítulo
          description: >-
            Cor do subtítulo da seção hero, em hexadecimal (#RRGGBB ou
            #RRGGBBAA)
          pattern: ^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$
          maxLength: 9
        cta_font_family:
          type: string
          nullable: true
          title: Fonte do CTA
          description: Fonte do botão de call to action da seção hero
          maxLength: 100
        cta_color:
          type: string
          nullable: true
          title: Cor do CTA
          description: >-
            Cor de fundo do botão de call to action, em hexadecimal (#RRGGBB ou
            #RRGGBBAA)
          pattern: ^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$
          maxLength: 9
        logo_font_family:
          type: string
          nullable: true
          title: Fonte do Rótulo do Logo
          description: Fonte do rótulo exibido ao lado do logo
          maxLength: 100
        logo_label:
          type: string
          nullable: true
          title: Rótulo do Logo
          description: Texto exibido ao lado do logo (vazio significa logo sem rótulo)
          maxLength: 255
        banner_overlay_enabled:
          type: boolean
          nullable: true
          title: Sobreposição do Banner Habilitada
          description: Indica se a sobreposição escura sobre a imagem do banner está ligada
        banner_overlay_color:
          type: string
          nullable: true
          title: Cor da Sobreposição do Banner
          description: 'Cor da sobreposição do banner, em hexadecimal (#RRGGBB ou #RRGGBBAA)'
          pattern: ^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$
          maxLength: 9
        banner_overlay_opacity:
          type: integer
          maximum: 100
          minimum: 0
          nullable: true
          title: Opacidade da Sobreposição do Banner
          description: >-
            Opacidade da sobreposição do banner em percentual (Inteiro entre 0 e
            100)
        support_email:
          type: string
          format: email
          title: E-mail de Suporte
          description: E-mail de suporte exibido ao aluno da área de membros
          maxLength: 254
        screen_capture_blocked:
          type: boolean
          title: Bloquear Captura de Tela
          description: >-
            Indica se o app e a área do aluno bloqueiam a captura do conteúdo
            onde o sistema permite
        ebook_watermark_enabled:
          type: boolean
          title: Marca d'Água em Ebooks
          description: Indica se todo PDF da área é entregue ao aluno com a marca d'água
        video_watermark_enabled:
          type: boolean
          title: Marca d'Água em Vídeos
          description: Indica se o player desenha a marca d'água sobre os vídeos da área
        watermark_fields:
          type: array
          items:
            $ref: '#/components/schemas/WatermarkFieldsEnum'
        copy_status:
          readOnly: true
          nullable: true
          title: Status da Cópia
          description: >-
            Andamento da cópia do conteúdo da área que nasceu da duplicação do
            produto (nulo quando a área não veio de cópia)


            * `copying` - Copiando

            * `done` - Concluída

            * `failed` - Falhou
          oneOf:
            - $ref: '#/components/schemas/CopyStatusEnum'
            - $ref: '#/components/schemas/NullEnum'
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Criado em
          description: Data de criação da área de membros
        updated_at:
          type: string
          format: date-time
          readOnly: true
          title: Atualizado em
          description: Data de atualização da área de membros
      required:
        - banner
        - banner_mobile
        - banner_mobile_original
        - banner_original
        - copy_status
        - created_at
        - id
        - logo
        - logo_original
        - name
        - product
        - support_email
        - updated_at
    StatusA90Enum:
      enum:
        - draft
        - published
        - deleted
      type: string
      description: |-
        * `draft` - Rascunho
        * `published` - Publicado
        * `deleted` - Excluído
    WatermarkFieldsEnum:
      enum:
        - email
        - name
        - cpf
      type: string
      description: |-
        * `email` - E-mail do aluno
        * `name` - Nome do aluno
        * `cpf` - CPF
    CopyStatusEnum:
      enum:
        - copying
        - done
        - failed
      type: string
      description: |-
        * `copying` - Copiando
        * `done` - Concluída
        * `failed` - Falhou
    NullEnum:
      enum:
        - null
  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.