Get a document by its ID | Elasticsearch API documentation

Path parameters

indexstring Required
The name of the index that contains the document.
idstring Required
A unique document identifier.

Query parameters

preferencestring
The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas.
If it is set to _local, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with "jumping values" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name.
realtimeboolean
If true, the request is real-time as opposed to near-real-time.
refreshboolean
If true, the request refreshes the relevant shards before retrieving the document. Setting it to true should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
routingstring
A custom value used to route operations to a specific shard.
_sourceboolean | string | array[string]
Indicates whether to return the _source field (true or false) or lists the fields to return.
_source_excludesstring | array[string]
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. If the _source parameter is false, this parameter is ignored.
_source_includesstring | array[string]
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.
stored_fieldsstring | array[string]
A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. Only leaf fields can be retrieved with the stored_field option. Object fields can't be returned;if specified, the request fails.
versionnumber
The version number for concurrency control. It must match the current version of the document for the request to succeed.
version_typestring
The version type.
Values are internal, external, external_gte, or force.

Responses

200 application/json
Hide response attributes Show response attributes object
- _indexstring Required
- fieldsobject
  If the stored_fields parameter is set to true and found is true, it contains the document fields stored in the index.
  Hide fields attribute Show fields attribute object
  *object Additional properties
- _ignoredarray[string]
- foundboolean Required
  Indicates whether the document exists.
- _idstring Required
- _primary_termnumber
  The primary term assigned to the document for the indexing operation.
- _routingstring
  The explicit routing, if set.
- _seq_nonumber
- _sourceobject
  If found is true, it contains the document data formatted in JSON. If the _source parameter is set to false or the stored_fields parameter is set to true, it is excluded.
- _versionnumber

GET /{index}/_doc/{id}

GET my-index-000001/_doc/1?stored_fields=tags,counter

resp = client.get(
    index="my-index-000001",
    id="1",
    stored_fields="tags,counter",
)

const response = await client.get({
  index: "my-index-000001",
  id: 1,
  stored_fields: "tags,counter",
});

response = client.get(
  index: "my-index-000001",
  id: "1",
  stored_fields: "tags,counter"
)

$resp = $client->get([
    "index" => "my-index-000001",
    "id" => "1",
    "stored_fields" => "tags,counter",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/my-index-000001/_doc/1?stored_fields=tags,counter"

Response examples (200)

A successful response from `GET my-index-000001/_doc/0`. It retrieves the JSON document with the `_id` 0 from the `my-index-000001` index.

{
  "_index": "my-index-000001",
  "_id": "0",
  "_version": 1,
  "_seq_no": 0,
  "_primary_term": 1,
  "found": true,
  "_source": {
    "@timestamp": "2099-11-15T14:12:12",
    "http": {
      "request": {
        "method": "get"
      },
      "response": {
        "status_code": 200,
        "bytes": 1070000
      },
      "version": "1.1"
    },
    "source": {
      "ip": "127.0.0.1"
    },
    "message": "GET /search HTTP/1.1 200 1070000",
    "user": {
      "id": "kimchy"
    }
  }
}

A successful response from `GET my-index-000001/_doc/1?stored_fields=tags,counter`, which retrieves a set of stored fields. Field values fetched from the document itself are always returned as an array. Any requested fields that are not stored (such as the counter field in this example) are ignored.

{
  "_index": "my-index-000001",
  "_id": "1",
  "_version": 1,
  "_seq_no" : 22,
  "_primary_term" : 1,
  "found": true,
  "fields": {
      "tags": [
        "production"
      ]
  }
}

A successful response from `GET my-index-000001/_doc/2?routing=user1&stored_fields=tags,counter`, which retrieves the `_routing` metadata field.

{
  "_index": "my-index-000001",
  "_id": "2",
  "_version": 1,
  "_seq_no" : 13,
  "_primary_term" : 1,
  "_routing": "user1",
  "found": true,
  "fields": {
      "tags": [
        "env2"
      ]
  }
}