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

# Listar Índices de Metadados

> Use este endpoint para consultar todos os índices de metadados. Você pode opcionalmente filtrar os resultados por nome de entidade.



## OpenAPI

````yaml pt/openapi/v3-current/ledger.yaml get /v1/settings/metadata-indexes
openapi: 3.1.0
info:
  title: API Midaz Ledger
  version: 4.0.0
servers:
  - url: /
security: []
tags:
  - name: Tipos de conta (v1)
  - name: Tipos de conta (v2)
  - name: Contas (v1)
  - name: Contas (v2)
  - name: Taxas de ativos (v1)
  - name: Ativos (v1)
  - name: Ativos (v2)
  - name: Saldos (v1)
  - name: Saldos (v2)
  - name: Cálculo de cobrança (v2)
  - name: Pacotes de cobrança (v2)
  - name: Composição (v2)
  - name: Criptografia (v2)
  - name: Taxas (v2)
  - name: Titulares (v2)
  - name: Instrumentos (v2)
  - name: Ledgers (v1)
  - name: Ledgers (v2)
  - name: Índices de metadados (v1)
  - name: Índices de metadados (v2)
  - name: Rotas de operação (v1)
  - name: Rotas de operação (v2)
  - name: Operações (v1)
  - name: Operações (v2)
  - name: Organizações (v1)
  - name: Organizações (v2)
  - name: Pacotes (v2)
  - name: Portfólios (v1)
  - name: Portfólios (v2)
  - name: Proteção (v2)
  - name: Segmentos (v1)
  - name: Segmentos (v2)
  - name: Rotas de transação (v1)
  - name: Rotas de transação (v2)
  - name: Transações (v1)
  - name: Transações (v2)
paths:
  /v1/settings/metadata-indexes:
    get:
      tags:
        - Índices de metadados (v1)
      summary: Listar Índices de Metadados
      description: >-
        Use este endpoint para consultar todos os índices de metadados. Você
        pode opcionalmente filtrar os resultados por nome de entidade.
      operationId: getAllMetadataIndexes
      parameters:
        - description: Optional entity name filter
          explode: false
          in: query
          name: entity_name
          schema:
            description: Optional entity name filter
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/MetadataIndex'
                type:
                  - array
                  - 'null'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyError'
          description: Error
      deprecated: true
      security:
        - BearerAuth: []
components:
  schemas:
    MetadataIndex:
      additionalProperties: false
      properties:
        entityName:
          examples:
            - transaction
          type: string
        indexName:
          examples:
            - metadata.tier_1
          type: string
        metadataKey:
          examples:
            - tier
          type: string
        sparse:
          examples:
            - true
          type: boolean
        stats:
          $ref: '#/components/schemas/IndexStats'
        unique:
          examples:
            - false
          type: boolean
      required:
        - indexName
        - entityName
        - metadataKey
        - unique
        - sparse
      type: object
    LegacyError:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable midaz error code. Identical to the code /v2
            returns for the same condition.
          examples:
            - '0065'
          type: string
        entityType:
          description: >-
            The domain entity the error concerns. Present only on
            field-validation errors.
          examples:
            - Account
          type: string
        fields:
          additionalProperties: {}
          description: >-
            Per-field validation detail, keyed by field name. The value is the
            violation message for a known field and the offending value for an
            unexpected one, so it is not always a string. The /v2 contract
            carries these as the 'errors' array.
          type: object
        message:
          description: >-
            Human-readable explanation of this occurrence. The /v2 contract
            carries this as 'detail'.
          type: string
        title:
          description: Short, human-readable summary of the error.
          examples:
            - Invalid Path Parameter
          type: string
      required:
        - title
        - message
        - code
      type: object
    IndexStats:
      additionalProperties: false
      properties:
        accesses:
          examples:
            - 1523
          format: int64
          type: integer
        statsSince:
          examples:
            - '2024-12-01T10:30:00Z'
          format: date-time
          type: string
      required:
        - accesses
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````