Skip to navigation
Product SearchRecords

Get Record

Get one record by its id. A record the key may not see answers 404 RECORD_NOT_FOUND, the same as an id that doesn’t exist. Get Records reads up to 100 at once.

Authentication

AuthorizationBearer

A search key, issued by Captain. Sent as Authorization: Bearer <key>.

OR
AuthorizationBearer

A scoped key for one end user, minted from an issuer key that Captain issues. Sent as Authorization: Bearer <key>.

Path parameters

indexstringRequiredformat: "^[a-z0-9][a-z0-9_-]{0,47}$"
index name
record_idstringRequired

Response headers

X-Captain-Applied-Seqinteger

the last update seq search had applied when this request started; the answer reflects at least that much (GET …/updates applied_seq). Not on 401 or 403, nor for an index this server does not have

X-Captain-Index-IncarnationstringOptional

the index’s incarnation, an opaque string: it changes only when the index is deleted and created again (whose seqs start again at 1), or restored from a backup (whose seqs continue from the backup’s). Sent with X-Captain-Applied-Seq

Response

record
idstringOptional
titlestringOptional
descriptionstringOptional
brandstringOptional
categorystringOptional
pricedoubleOptional
ratingdoubleOptional
image_urlstringOptional
attributesobjectOptional
identifierslist of stringsOptional
fieldsobjectOptional