get-documents
Retrieve specific documents from a Meilisearch index by specifying the index UID, filters, fields, and pagination settings for precise data extraction.
Instructions
Get documents from a Meilisearch index
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Fields to return in the documents | |
| filter | No | Filter query to apply | |
| indexUid | Yes | Unique identifier of the index | |
| limit | No | Maximum number of documents to return (default: 20) | |
| offset | No | Number of documents to skip (default: 0) |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"fields": {
"description": "Fields to return in the documents",
"items": {
"type": "string"
},
"type": "array"
},
"filter": {
"description": "Filter query to apply",
"type": "string"
},
"indexUid": {
"description": "Unique identifier of the index",
"type": "string"
},
"limit": {
"description": "Maximum number of documents to return (default: 20)",
"maximum": 1000,
"minimum": 1,
"type": "number"
},
"offset": {
"description": "Number of documents to skip (default: 0)",
"minimum": 0,
"type": "number"
}
},
"required": [
"indexUid"
],
"type": "object"
}