[[reference-mget]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
=== client.mget

Get multiple documents. 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.

{ref}/docs-multi-get.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(MgetRequest, options?): Promise<MgetResponse>
----

[discrete]
===== `MgetRequest`

[source,ts]
----
interface MgetRequest extends <<shared-type-request-base, RequestBase>> {
  index?: <<shared-type-index-name, IndexName>>
  force_synthetic_source?: boolean
  preference?: string
  realtime?: boolean
  refresh?: boolean
  routing?: <<shared-type-routing, Routing>>
  _source?: SearchSourceConfigParam
  _source_excludes?: <<shared-type-fields, Fields>>
  _source_includes?: <<shared-type-fields, Fields>>
  stored_fields?: <<shared-type-fields, Fields>>
  docs?: MgetOperation[]
  ids?: <<shared-type-ids, Ids>>
}
----

[discrete]
===== `MgetResponse`

[source,ts]
----
interface MgetResponse<TDocument = unknown> {
  docs: MgetResponseItem<TDocument>[]
}
----

