Get multiple documents

GET /{index}/_mget

Copy endpoint

Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.

Filter source fields

By default, the _source field is returned for every document (if stored). Use the _source and _source_include or source_exclude attributes to filter what fields are returned for a particular document. You can include the _source, _source_includes, and _source_excludes query parameters in the request URI to specify the defaults to use when there are no per-document instructions.

Get stored fields

Use the stored_fields attribute to specify the set of stored fields you want to retrieve. Any requested fields that are not stored are ignored. You can include the stored_fields query parameter in the request URI to specify the defaults to use when there are no per-document instructions.

Required authorization

Index privileges: read

Parameters

path Path Parameters

Name	Type
`index` required Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.	type TypesIndexName = string

query Query Parameters

Name	Type
`preference` Specifies the node or shard the operation should be performed on. Random by default.	string
`realtime` If `true`, the request is real-time as opposed to near-real-time.	boolean
`refresh` If `true`, the request refreshes relevant shards before retrieving documents.	boolean
`routing` Custom value used to route operations to a specific shard.	type TypesRouting = string[] \| string
`_source` True or false to return the `_source` field or not, or a list of fields to return.	type GlobalSearchTypesSourceConfigParam = type TypesFields = type TypesField = string \| type TypesField = string[] \| boolean
`_source_excludes` A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.	type TypesFields = type TypesField = string \| type TypesField = string[]
`_source_includes` A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.	type TypesFields = type TypesField = string \| type TypesField = string[]
`stored_fields` If `true`, retrieves the document fields stored in the index rather than the document `_source`.	type TypesFields = type TypesField = string \| type TypesField = string[]

Request Body

application/json required

{ docs?:

GlobalMgetOperation

interface GlobalMgetOperation {
_id: TypesId;
_index?: TypesIndexName;
routing?: TypesRouting;
_source?: GlobalSearchTypesSourceConfig;
stored_fields?: TypesFields;
version?: TypesVersionNumber;
version_type?: TypesVersionType;
}

[];ids?:

TypesIds

type TypesIds = TypesId | TypesId[]

; }

Responses

200 application/json

{ docs:

GlobalMgetResponseItem

type GlobalMgetResponseItem = GlobalGetGetResult | GlobalMgetMultiGetError

[]; }