Get multiple documents

POST also GET /{index}/_mget
POST also GET /_mget

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

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Request body

Response

application/json

docs union oneOf[] required: The response includes a docs array that contains the documents in the order specified in the request. The structure of the returned documents is similar to that returned by the get API. If there is a failure getting a particular document, the error is included in place of the document.; One of:

Examples

Request Console 1 / 8 languages

Run POST /my-index-000001/_mget. When you specify an index in the request URI, only the document IDs are required in the request body.

Console Kibana Dev Tools

POST /my-index-000001/_mget
{
  "docs": [
    {
      "_id": "1"
    },
    {
      "_id": "2"
    }
  ]
}

JavaScript Elasticsearch JavaScript Client

const response = await client.mget({
  index: "my-index-000001",
  docs: [
    {
      _id: "1",
    },
    {
      _id: "2",
    },
  ],
});

Python Elasticsearch Python Client

resp = client.mget(
    index="my-index-000001",
    docs=[
        {
            "_id": "1"
        },
        {
            "_id": "2"
        }
    ],
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-000001/_mget" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "docs": [
      {
        "_id": "1"
      },
      {
        "_id": "2"
      }
    ]
  }'

Java Elasticsearch Java Client

client.mget(m -> m
    .docs(List.of(MultiGetOperation.of(mu -> mu
            .id("1")
        ),MultiGetOperation.of(mu -> mu
            .id("2")
        )))
    .index("my-index-000001")
);

C# Elasticsearch .NET Client

var response = await client
    .MultiGetAsync<MyDocument>(d1 => d1
        .Index("my-index-000001")
        .Docs(d2 => d2
            .Id("1"), d2 => d2
            .Id("2")
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->mget([
    "index" => "my-index-000001",
    "body" => [
        "docs" => array(
            [
                "_id" => "1",
            ],
            [
                "_id" => "2",
            ],
        ),
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.mget(
  index: "my-index-000001",
  body: {
    "docs": [
      {
        "_id": "1"
      },
      {
        "_id": "2"
      }
    ]
  }
)

Response

No example

Request Console 1 / 2 languages

Run POST /_mget. This request sets _source to false for document 1 to exclude the source entirely. It retrieves field3 and field4 from document 2. It retrieves the user field from document 3 but filters out the user.location field.

Console Kibana Dev Tools

POST /_mget
{
  "docs": [
    {
      "_index": "test",
      "_id": "1",
      "_source": false
    },
    {
      "_index": "test",
      "_id": "2",
      "_source": [ "field3", "field4" ]
    },
    {
      "_index": "test",
      "_id": "3",
      "_source": {
        "include": [ "user" ],
        "exclude": [ "user.location" ]
      }
    }
  ]
}

Generated from the API spec

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_mget" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "docs": [
      {
        "_index": "test",
        "_id": "1",
        "_source": false
      },
      {
        "_index": "test",
        "_id": "2",
        "_source": [ "field3", "field4" ]
      },
      {
        "_index": "test",
        "_id": "3",
        "_source": {
          "include": [ "user" ],
          "exclude": [ "user.location" ]
        }
      }
    ]
  }'

Generated from the API spec

Response

No example

Request Console 1 / 2 languages

Run POST /_mget. This request retrieves field1 and field2 from document 1 and field3 and field4 from document 2.

Console Kibana Dev Tools

POST /_mget
{
  "docs": [
    {
      "_index": "test",
      "_id": "1",
      "stored_fields": [ "field1", "field2" ]
    },
    {
      "_index": "test",
      "_id": "2",
      "stored_fields": [ "field3", "field4" ]
    }
  ]
}

Generated from the API spec

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_mget" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "docs": [
      {
        "_index": "test",
        "_id": "1",
        "stored_fields": [ "field1", "field2" ]
      },
      {
        "_index": "test",
        "_id": "2",
        "stored_fields": [ "field3", "field4" ]
      }
    ]
  }'

Generated from the API spec

Response

No example

Request Console 1 / 2 languages

Run POST /_mget?routing=key1. If routing is used during indexing, you need to specify the routing value to retrieve documents. This request fetches test/_doc/2 from the shard corresponding to routing key key1. It fetches test/_doc/1 from the shard corresponding to routing key key2.

Console Kibana Dev Tools

POST /_mget?routing=key1
{
  "docs": [
    {
      "_index": "test",
      "_id": "1",
      "routing": "key2"
    },
    {
      "_index": "test",
      "_id": "2"
    }
  ]
}

Generated from the API spec

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_mget?routing=key1" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "docs": [
      {
        "_index": "test",
        "_id": "1",
        "routing": "key2"
      },
      {
        "_index": "test",
        "_id": "2"
      }
    ]
  }'

Generated from the API spec

Response

No example