Skip to main content
GET
/
indexes
cURL
curl \
  -X GET 'MEILISEARCH_URL/indexes?limit=3'
{
  "results": [
    {
      "uid": "movies",
      "primaryKey": "movie_id",
      "createdAt": "2019-11-20T09:40:33.711324Z",
      "updatedAt": "2019-11-20T09:40:33.711324Z"
    }
  ],
  "limit": 1,
  "offset": 0,
  "total": 1
}

Authorizations

​
Authorization
string
header
required

An API key is a token that you provide when making API calls. Read more about how to secure your project.

Include the API key to the Authorization header, for instance:

-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'

If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:

const client = new MeiliSearch({
  host: 'MEILISEARCH_URL',
  apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'
});

Query Parameters

​
offset
integer

The number of indexes to skip before starting to retrieve anything.

Required range: x >= 0
​
limit
integer
default:20

The number of indexes to retrieve.

Required range: x >= 0

Response

Indexes are returned.

​
results
object[]
required

Items for the current page.

​
offset
integer
required

Number of items skipped.

Required range: x >= 0
​
limit
integer
required

Maximum number of items returned.

Required range: x >= 0
​
total
integer
required

Total number of items matching the query.

Required range: x >= 0