Documents - Get

Service:

Search Service

API Version:

2024-05-01-preview

Retrieves a document from the index.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2024-05-01-preview

With optional parameters:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2024-05-01-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	The endpoint URL of the search service.
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	Client Api Version.
$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
x-ms-client-request-id		string uuid	The tracking ID sent with the request to help with debugging.

Responses

Name	Type	Description
200 OK	LookupDocument	Response containing the requested document.
Other Status Codes	ErrorResponse	Error response.

Examples

SearchIndexGetDocument

Sample request

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs('1')?$select=docId,title,description&api-version=2024-05-01-preview

Sample response

Status code:

200

{
  "description": "Cheapest hotel in town",
  "docId": "1",
  "title": "Nice Hotel"
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

ErrorAdditionalInfo

The resource management error additional info.

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

ErrorDetail

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

Error response

Name	Type	Description
error	ErrorDetail	The error object.