DocsAPI Reference
  • Data API
    • POSTGet BIN
LogoLogo
Login
Login
Data APIRecords

GET
/v1/vaults/:vaultID/:tableName
GET
/v1/vaults/:vaultID/:tableName
1curl -G https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/vaults/a451b783713e4424a7c761bb7bbc84ea/persons \
2     -H "Authorization: Bearer <token>" \
3     -d returnFileMetadata=true
Try it
1{
2  "records": [
3    {
4      "fields": {
5        "Estimated Value": 10000,
6        "Expected Close Date": "2017-07-12",
7        "Opportunity Name": "BPS Pilot",
8        "Owner": {
9          "email": "kat+collab15@skyflow.com",
10          "id": "usrijG9SC4EQlq5cm",
11          "name": "Jess Patel"
12        },
13        "Priority": "Medium",
14        "Proposal Deadline": "2017-06-14",
15        "Status": "Qualification"
16      }
17    },
18    {
19      "fields": {
20        "Estimated Value": 24791,
21        "Expected Close Date": "2017-07-07",
22        "Opportunity Name": "BPS second use case",
23        "Owner": {
24          "email": "kat+collab36@skyflow.com",
25          "id": "usrGqHsNLhH41Q91M",
26          "name": "Sandy Hagen"
27        },
28        "Priority": "Very Low Deprioritize",
29        "Status": "Proposal"
30      }
31    }
32  ]
33}
Was this page helpful?
Previous

Insert Records

Next
Built with
Gets the specified records from a table.

Authentication

AuthorizationBearer
Access token, prefixed by Bearer: Bearer &lt;token&gt;. Retrieved using <a href='https://readme.skyflow.com/reference/Authentication/OAuth2'>OAuth2</a> security scheme.

Path Parameters

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

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`.<br /><br />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`.<br /><br />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`.<br /><br />`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

Access token, prefixed by Bearer: Bearer <token>. Retrieved using OAuth2 security scheme.

Redaction level to enforce for the returned records. Subject to policies assigned to the API caller.
Record position at which to start receiving data.
Number of record to return. Maximum 25.
A successful response.

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.

Get Record(s)

If true, returns file metadata.

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

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.

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.

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.

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.

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