Get pagination configuration

GET /indexes/{indexUid}/settings/pagination

Get the pagination configuration of an index.

Path parameters

  • indexUid string Required

    Index Unique Identifier

Responses

  • 200 application/json

    Ok

    Hide response attribute Show response attribute object
    • Define the maximum number of documents reachable for a search request. It means that with the default value of 1000, it is not possible to see the 1001st result for a search query.

      Default value is 1000.

  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
  • 404

    Not Found

GET /indexes/{indexUid}/settings/pagination
curl \
 -X GET https://example.meilisearch.com:7700/indexes/movies/settings/pagination \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "maxTotalHits": 1000
}
Response examples (401)
{
  "message": "The Authorization header is missing. It must use the bearer authorization method.",
  "code": "missing_authorization_header",
  "type": "auth",
  "link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}