GET /search/indexes/{name}/documents/{document_id}
Read a document
Read one document of an index by its id. Use when checking what an index holds for one record. Before: a document id from search_query. Returns the stored document. Scope: search:query.
API key (Bearer), on the public API endpoint.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
name | path | string · required | Index name. |
document_id | path | string · required | Document id. |
Responses
| Status | Description | Body |
|---|---|---|
2XX | Success: the JSON body the route returns (see the description for its fields). | object |
401 | Key missing or invalid | Error |
4XX | Refused: act on detail.code, then follow detail.next_action (404 not_found while the service is not open to the account). | Error |
Examples
curl
curl -X GET "$GALON_API_BASE/search/indexes/<name>/documents/<document_id>" \
-H "Authorization: Bearer $GALON_API_KEY"