Documents - Get

Service:

Search Service

API Version:

2025-11-01-preview

Retrieves a document from the index.

GET https:///indexes('{indexName}')/docs('{key}')?api-version=2025-11-01-preview

With optional parameters:

GET https:///indexes('{indexName}')/docs('{key}')?api-version=2025-11-01-preview&$select={$select}

URI Parameters

Name	In	Required	Type	Description
indexName	path	True	string	The name of the index.
key	path	True	string	The key of the document to retrieve.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$select	query		string[]	List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.

Request Header

Name	Required	Type	Description
Accept		Accept	The Accept header.
x-ms-query-source-authorization		string	Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents.
x-ms-enable-elevated-read		boolean	A value that enables elevated read that bypass document level permission checks for the query operation.
x-ms-client-request-id		string (uuid)	An opaque, globally-unique, client-generated string identifier for the request.

Responses

Name	Type	Description
200 OK	LookupDocument	The request has succeeded.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name	Description
https://search.azure.com/.default

Examples

SearchIndexGetDocument

Sample request

HTTP

GET https:///indexes('preview-test')/docs('1')?api-version=2025-11-01-preview&$select=id,description,name,category,ownerId

Sample response

Status code:

200

{
  "id": "1",
  "name": "test",
  "description": "test1 hello",
  "category": "purple",
  "ownerId": "sam"
}

Definitions

Name	Description
Accept	The Accept header.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Accept

Enumeration

The Accept header.

Value	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info		The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name	Type	Description
error	ErrorDetail	The error object.