Get Records

GET https://%7B%7Bvault_uri%7D%7D.vault.skyflowapis.com/v1/vaults/{vaultID}/{objectName}

Returns the specified records from a table.

Authentication

• Authorization header (bearer token, required) — Access token, prefixed by Bearer .

Servers

• https://%7B%7Bvault_uri%7D%7D.vault.skyflowapis.com (Production, default)
• https://%7B%7Bvault_uri%7D%7D.vault.skyflowapis-preview.com (Sandbox)

Request

Path parameters

• vaultID (string, required)
• objectName (string, required)

Query parameters

• skyflow_ids (list of string, optional)
• redaction (enum, optional)
  • Allowed values: DEFAULT, REDACTED, MASKED, PLAIN_TEXT
• tokenization (boolean, optional)
• fields (list of string, optional)
• offset (string, optional)
• limit (string, optional)
• downloadURL (boolean, optional)
• column_name (string, optional)
• column_values (list of string, optional)
• order_by (enum, optional)
  • Allowed values: ASCENDING, DESCENDING, NONE
• returnFileMetadata (boolean, optional)

Response

200

OK

• records (list of object, optional) — The specified records.
  • fields (map from string to any, optional) — Fields and values for the record. For example, {'field_1':'value_1', 'field_2':'value_2'}.
  • tokens (map from string to any, optional) — Fields and tokens for the record. For example, {'field_1':'token_1', 'field_2':'token_2'}.
  • fileMetadata (map from string to object, optional) — Metadata for the uploaded file, keyed by dynamic column name.
    • fileName (string, optional) — Name of the file, including the extension if provided.
    • fileSizeKB (uint, optional) — Size of the file in kilobytes (KB), rounded up from bytes to the nearest KB.
    • fileType (string, optional) — Type of the file, detected based on its content (MIME type).

Errors

400 Bad Request Error

Returned when the request is invalid or cannot be served.

• error (object, required)
  • grpc_code (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
  • http_code (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
  • http_status (string, required)
  • message (string, required)
  • details (list of map from string to any, optional)

401 Unauthorized Error

Returned when the request is unauthorized.

• error (object, required)
  • grpc_code (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
  • http_code (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
  • http_status (string, required)
  • message (string, required)
  • details (list of map from string to any, optional)

404 Not Found Error

Returned when a resource doesn’t exist.

• error (object, required)
  • grpc_code (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
  • http_code (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
  • http_status (string, required)
  • message (string, required)
  • details (list of map from string to any, optional)

422 Unprocessable Entity Error

Returned when the request is well-formed but contains semantic errors that prevent it from being processed.

• error (object, required)
  • grpc_code (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
  • http_code (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
  • http_status (string, required)
  • message (string, required)
  • details (list of map from string to any, optional)

500 Internal Server Error

An unexpected error response.

• error (object, required)
  • grpc_code (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
  • http_code (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
  • http_status (string, required)
  • message (string, required)
  • details (list of map from string to any, optional)

Examples

Response

{
  "records": [
    {
      "fields": {
        "Estimated Value": 10000,
        "Expected Close Date": "2017-07-12",
        "Opportunity Name": "BPS Pilot",
        "Owner": {
          "email": "kat+collab15@skyflow.com",
          "id": "usrijG9SC4EQlq5cm",
          "name": "Jess Patel"
        },
        "Priority": "Medium",
        "Proposal Deadline": "2017-06-14",
        "Status": "Qualification"
      }
    },
    {
      "fields": {
        "Estimated Value": 24791,
        "Expected Close Date": "2017-07-07",
        "Opportunity Name": "BPS second use case",
        "Owner": {
          "email": "kat+collab36@skyflow.com",
          "id": "usrGqHsNLhH41Q91M",
          "name": "Sandy Hagen"
        },
        "Priority": "Very Low Deprioritize",
        "Status": "Proposal"
      }
    }
  ]
}

SDK Code

import requests

url = "https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())

const url = 'https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName")
  .header("Authorization", "Bearer <token>")
  .asString();

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();

using RestSharp;

var client = new RestClient("https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);

import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/objectName")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()