Data APIRecords

Get Record(s)

Gets the specified records from a table.

Path parameters

vaultIDstringRequired
ID of the vault.
tableNamestringRequired
Name of the table that contains the records.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

skyflow_idslist of stringsOptional

skyflow_id values of the records to return, with one value per skyflow_ids URL parameter. For example, ?skyflow_ids=abc&skyflow_ids=123.

If not specified, returns the first 25 records in the table.

redactionenumOptionalDefaults to DEFAULT
Redaction level to enforce for the returned records. Subject to policies assigned to the API caller.
Allowed values:
tokenizationbooleanOptional

If true, this operation returns tokens for fields with tokenization enabled. Only applicable if skyflow_id values are specified.

returnFileMetadatabooleanOptional

If true, returns file metadata.

fieldslist of stringsOptional

Fields to return for the record, with one value per fields URL parameter. For example, ?fields=abc&fields=123.

If not specified, returns all fields.

offsetstringOptionalformat: "int64"Defaults to 0
Record position at which to start receiving data.
limitstringOptionalformat: "int64"Defaults to 25
Number of record to return. Maximum 25.
downloadURLbooleanOptional

If true, returns download URLs for fields with a file data type. URLs are valid for 15 minutes. If virus scanning is enabled, only returns if the file is clean.

column_namestringOptional

Name of the column. It must be configured as unique in the schema. If you provide both column name or column value, you cannot use skyflow_ids. Passing either of these parameters with skyflow_ids returns an error.

column_valueslist of stringsOptional

Column values of the records to return, with one value per column_values URL parameter. For example, ?column_values=abc&column_values=123.

column_name is mandatory when providing column_values. If you use column name or column value, you cannot use skyflow_ids. Passing either of these parameters with skyflow_ids returns an error.

order_byenumOptionalDefaults to ASCENDING

Order to return records, based on skyflow_id values. To disable, set to NONE.

Allowed values:

Response

A successful response.
recordslist of objects or null
The specified records.

Errors