> ## 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 planos de acesso

> Os planos ativos da área (duração do acesso).

#### Escopo

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


## OpenAPI

````yaml GET /public_api/members/areas/{member_area_id}/access-plans/
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}/access-plans/:
    get:
      tags:
        - members
      summary: Listar planos de acesso
      description: >-
        Os planos ativos da área (duração do acesso). O `id` vai no convite e na
        importação.
      operationId: members_areas_access_plans_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/MembersAccessPlanList'
          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:
    MembersAccessPlanList:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/MemberAreaAccessPlansList'
      required:
        - results
    UnauthenticatedError:
      type: object
      properties:
        detail:
          type: string
    MemberAreaAccessPlansList:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: Identificador único do plano de acesso no sistema
        code:
          type: string
          readOnly: true
          title: Código
          description: >-
            Código identificador em formato legível do plano de acesso. Único
            por área de membros
        name:
          type: string
          readOnly: true
          title: Nome
          description: Nome do plano de acesso
        description:
          type: string
          readOnly: true
          title: Descrição
          description: Descrição do plano de acesso
        duration_days:
          type: integer
          readOnly: true
          nullable: true
          title: Duração em dias
          description: Duração do plano de acesso em dias, nulo para plano vitalício
        is_default:
          type: boolean
          readOnly: true
          title: Plano Padrão
          description: Indica se este é o plano de acesso padrão para a área de membros
        status:
          allOf:
            - $ref: '#/components/schemas/Status148Enum'
          readOnly: true
          description: |-
            Status atual do plano de acesso

            * `active` - Ativo
            * `inactive` - Inativo
            * `deleted` - Excluído
      required:
        - code
        - description
        - duration_days
        - id
        - is_default
        - name
        - status
    Status148Enum:
      enum:
        - active
        - inactive
        - deleted
      type: string
      description: |-
        * `active` - Ativo
        * `inactive` - Inativo
        * `deleted` - Excluído
  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.