Data APIRecords

Get Record By ID

Returns the specified record from a table.

Authentication

AuthorizationBearer

Access token, prefixed by Bearer .

Path parameters

vaultIDstringRequired
objectNamestringRequired
IDstringRequired

Query parameters

redactionenumOptional
Allowed values:
tokenizationbooleanOptional
fieldslist of stringsOptional
downloadURLbooleanOptional
returnFileMetadatabooleanOptional

Response headers

X-Request-IDstring
Unique identifier for the request.

Response

OK
fieldsmap from strings to any

Fields and values for the record. For example, {'field_1':'value_1', 'field_2':'value_2'}.

tokensmap from strings to any

Fields and tokens for the record. For example, {'field_1':'token_1', 'field_2':'token_2'}.

fileMetadatamap from strings to objects
Metadata for the uploaded file, keyed by dynamic column name.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error