Skip to main content
GET
/
indexes
/
{indexUid}
/
documents
cURL
curl \
  -X GET 'MEILISEARCH_URL/indexes/movies/documents?limit=2&filter=genres=action'
{
  "results": [
    {
      "id": 25684,
      "title": "American Ninja 5",
      "poster": "https://image.tmdb.org/t/p/w1280/iuAQVI4mvjI83wnirpD8GVNRVuY.jpg",
      "overview": "When a scientists daughter is kidnapped, American Ninja, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the ninja.",
      "release_date": 725846400
    },
    {
      "id": 45881,
      "title": "The Bridge of San Luis Rey",
      "poster": "https://image.tmdb.org/t/p/w500/4X7quIcdkc24Cveg5XdpfRqxtYA.jpg",
      "overview": "The Bridge of San Luis Rey is American author Thornton Wilder's second novel, first published in 1927 to worldwide acclaim. It tells the story of several interrelated people who die in the collapse of an Inca rope-fiber suspension bridge in Peru, and the events that lead up to their being on the bridge.[ A friar who has witnessed the tragic accident then goes about inquiring into the lives of the victims, seeking some sort of cosmic answer to the question of why each had to die. The novel won the Pulitzer Prize in 1928.",
      "release_date": 1072915200
    }
  ],
  "limit": 20,
  "offset": 0,
  "total": 2
}

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.

Query Parameters

​
offset
integer

Number of documents to skip in the response. Use this parameter together with limit to paginate through large document sets. For example, to get documents 21-40, set offset=20 and limit=20. Defaults to 0.

Required range: x >= 0
​
limit
integer

Maximum number of documents to return in a single response. Use together with offset for pagination. Defaults to 20.

Required range: x >= 0
​
fields
string[]

Comma-separated list of document attributes to include in the response. Use * to retrieve all attributes. By default, all attributes are returned. Example: title,description,price.

​
retrieveVectors
boolean

When true, includes vector embeddings in the response for documents that have them. This is useful when you need to inspect or export vector data. Defaults to false.

​
ids
string[]

Comma-separated list of document IDs to retrieve. Only documents with matching IDs will be returned. If not specified, all documents matching other criteria are returned.

​
filter
string

Filter expression to select which documents to return. Uses the same syntax as search filters. Only documents matching the filter will be included in the response. Example: genres = action AND rating > 4.

​
sort
string

Attribute(s) to sort the documents by. Format: attribute:asc or attribute:desc. Multiple sort criteria can be comma-separated. Example: price:asc,rating:desc.

Response

The documents are returned.

​
results
any[]
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