Get pagination

Returns the current value of the pagination setting for the index.

GET /indexes/{indexUid}/settings/pagination

cURL

cURL

curl \
  -X GET 'MEILISEARCH_URL/indexes/books/settings/pagination'

200

{}

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'
});

Path Parameters

indexUid · string · required

Unique identifier of the index.

Response

200

application/json

Returns the current value of the pagination setting.

Pagination configuration settings

maxTotalHits · integer | null

Maximum number of hits that can be returned

Required range: x >= 0

Example:

250