---
title: "Get indices"
method: GET
path: "/api/dataentities/{dataEntityName}/indices"
tags: ["Indices"]
---

# Get indices

`GET /api/dataentities/{dataEntityName}/indices`

Returns the list of [indices](https://developers.vtex.com/docs/guides/master-data-components#index) by data entity. 

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Dynamic Storage | Index | **View index details** |
| Dynamic Storage | Index | **List index** |
| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Path parameters

- `dataEntityName` string, required

## Headers

- `Content-Type` string, required

## Response `200`

OK

- Index[] — Array with information about indices.
  - `name` string — Index name.
  - `acronym` string — Data entity name.
  - `isGlobal` boolean — Defines whether the index is global (`true`) or not (`false`).
  - `multiple` boolean — Determines whether the values need to be unique. If `false`, values must be unique.
  - `fields` string — Comma-separated fields of the index.

## Changes

- **2023-10-19** `cee1735dc206` — 1 info
  - added the media type `application/json` for the response with the status `200`

[Change history](https://skmtc.dev/vtex/apis/master-data-api-v2/changes/api/dataentities/:dataEntityName/indices/get.md)

---

[API](https://skmtc.dev/vtex/apis/master-data-api-v2.md) · [All operations](https://skmtc.dev/vtex/apis/master-data-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/master-data-api-v2/revisions/6d3f8010fa54/schema)