> ## 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 Metadata > Use este endpoint para consultar todos os índices de metadata. 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 description: >- Referência completa da API para serviços do Midaz Ledger incluindo gerenciamento de organizações, operações de ledger, ativos, segmentos, portfolios, contas, tipos de conta, transações, operações, saldos, rotas de operação, rotas de transação e índices de metadata. version: 3.7.8 servers: - url: https://ledger.sandbox.lerian.net security: [] tags: - name: API de Organizações - name: API de Ledgers - name: API de Ativos - name: API de Segmentos - name: API de Portfolios - name: API de Tipos de Conta - name: API de Contas - name: API de Saldos - name: API de Transações - name: API de Operações - name: API de Rotas de Operação - name: API de Rotas de Transação - name: API de Índices de Metadata - name: API de Titulares - name: API de Instrumentos - name: API de Pacotes de Cobrança - name: API de Pacotes - name: API de Cálculo de Cobrança - name: API de Estimativa - name: API de Criptografia - name: API de Proteção - name: API de Taxas de Ativos paths: /v1/settings/metadata-indexes: get: tags: - API de Índices de Metadata summary: Listar Índices de Metadata description: >- Use este endpoint para consultar todos os índices de metadata. Você pode opcionalmente filtrar os resultados por nome de entidade. parameters: - name: entity_name in: query description: O nome da entidade para filtrar os índices de metadata. required: false example: transaction schema: type: string - $ref: '#/components/parameters/ContentType' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Authorization' responses: '200': description: >- Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados. content: application/json: schema: type: array items: $ref: '#/components/schemas/MetadataIndexWithStatsResponse' example: - indexName: metadata.tier_1 entityName: transaction metadataKey: tier unique: false sparse: true stats: accesses: 150 statsSince: '2024-01-15T10:30:00Z' - indexName: metadata.externalId_1 entityName: account metadataKey: externalId unique: true sparse: false stats: accesses: 1200 statsSince: '2024-01-10T08:00:00Z' headers: {} '400': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0138: $ref: '#/components/examples/Error0138' headers: {} '401': description: Não autorizado content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0041: $ref: '#/components/examples/Error0041' Error0042: $ref: '#/components/examples/Error0042' '403': description: Proibido content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0043: $ref: '#/components/examples/Error0043' '500': description: Erro Interno do Servidor content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0046: $ref: '#/components/examples/Error0046' components: parameters: ContentType: name: Content-Type in: header description: O tipo de mídia do recurso. O valor recomendado é `application/json`. required: false example: application/json schema: type: string XRequestId: name: X-Request-Id in: header description: >- Um identificador único utilizado para rastrear e acompanhar cada requisição. required: false example: 019c96a0-0a98-7287-9a31-786e0809c769 schema: type: string format: uuid Authorization: name: Authorization in: header required: false schema: type: string description: > Token JWT bearer para autenticação. Obrigatório quando `PLUGIN_AUTH_ENABLED=true` (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: `Bearer ` schemas: MetadataIndexWithStatsResponse: type: object description: >- O corpo da resposta para um índice de metadata incluindo estatísticas de uso. required: - indexName - entityName - metadataKey - unique - sparse properties: indexName: type: string description: O nome do índice no banco de dados. examples: - metadata.tier_1 entityName: type: string description: O nome da entidade associada ao índice. examples: - transaction metadataKey: type: string description: A chave de metadata utilizada no índice. examples: - tier unique: type: boolean description: Indica se o índice exige unicidade. examples: - false sparse: type: boolean description: >- Indica se o índice é esparso (ignora documentos sem o campo indexado). examples: - true stats: type: object description: Estatísticas de uso do índice. required: - accesses properties: accesses: type: integer description: O número de vezes que o índice foi acessado. examples: - 150 statsSince: type: string format: date-time description: >- A data e hora desde quando as estatísticas estão sendo coletadas. examples: - '2024-01-15T10:30:00Z' ErrorFormat: type: object description: A mensagem de erro da resposta. required: - code - title - message properties: code: type: string description: Um identificador único e estável para o erro. title: type: string description: Um breve resumo do problema. message: type: string description: Orientação detalhada para resolver o erro. entityType: type: string description: >- O tipo de entidade ao qual o erro se refere (por exemplo, organization, ledger, account, transaction). Opcional. fields: type: object additionalProperties: true description: Informações adicionais sobre os campos que causaram o erro. examples: Error0138: summary: Invalid Entity Name value: code: '0138' title: Invalid Entity Name message: >- The provided entity name is not valid. Accepted values are: organization, ledger, asset, segment, portfolio, account, transaction, operation, account_type, operation_route, transaction_route. Error0041: summary: Token Missing value: code: '0041' title: Token Missing message: >- A valid token must be provided in the request header. Please include a token and try again. Error0042: summary: Invalid Token value: code: '0042' title: Invalid Token message: >- The provided token is expired, invalid or malformed. Please provide a valid token and try again. Error0043: summary: Insufficient Privileges value: code: '0043' title: Insufficient Privileges message: >- You do not have the necessary permissions to perform this action. Please contact your administrator if you believe this is an error. Error0046: summary: Internal Server Error value: code: '0046' title: Internal Server Error message: >- The server encountered an unexpected error. Please try again later or contact support. ````