`GET /orgs/{org_id}/connectors/{connector_id}/browse/table`
curl --request GET \
--url https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/browse/table \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/browse/table"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/browse/table', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/browse/table",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/browse/table"
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(string(body))
}HttpResponse<String> response = Unirest.get("https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/browse/table")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/browse/table")
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{
"approx_rows": 123,
"check_constraints": [
{
"definition": "<string>",
"name": "<string>"
}
],
"columns": [
{
"cursor_candidate": true,
"data_type": "<string>",
"name": "<string>",
"nullable": true,
"comment": "<string>",
"default": "<string>",
"generated": true,
"identity": true,
"max_length": 123,
"numeric_precision": 123,
"numeric_scale": 123,
"pk_position": 1,
"unique": true
}
],
"foreign_keys": [
{
"columns": [
"<string>"
],
"name": "<string>",
"ref_columns": [
"<string>"
],
"ref_schema": "<string>",
"ref_table": "<string>",
"on_delete": "<string>",
"on_update": "<string>"
}
],
"indexes": [
{
"columns": [
"<string>"
],
"name": "<string>",
"primary": true,
"unique": true,
"kind": "<string>"
}
],
"name": "<string>",
"schema": "<string>",
"comment": "<string>",
"size_bytes": 123
}Browse
Browse Table
Full introspection of one remote table: rich columns (defaults, identity, comments, precision), indexes, foreign keys, check constraints, table comment and size. Requires a connector advertising browse:describe (0.1.25+).
GET
/
orgs
/
{org_id}
/
connectors
/
{connector_id}
/
browse
/
table
`GET /orgs/{org_id}/connectors/{connector_id}/browse/table`
curl --request GET \
--url https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/browse/table \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/browse/table"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/browse/table', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/browse/table",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/browse/table"
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(string(body))
}HttpResponse<String> response = Unirest.get("https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/browse/table")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/browse/table")
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{
"approx_rows": 123,
"check_constraints": [
{
"definition": "<string>",
"name": "<string>"
}
],
"columns": [
{
"cursor_candidate": true,
"data_type": "<string>",
"name": "<string>",
"nullable": true,
"comment": "<string>",
"default": "<string>",
"generated": true,
"identity": true,
"max_length": 123,
"numeric_precision": 123,
"numeric_scale": 123,
"pk_position": 1,
"unique": true
}
],
"foreign_keys": [
{
"columns": [
"<string>"
],
"name": "<string>",
"ref_columns": [
"<string>"
],
"ref_schema": "<string>",
"ref_table": "<string>",
"on_delete": "<string>",
"on_update": "<string>"
}
],
"indexes": [
{
"columns": [
"<string>"
],
"name": "<string>",
"primary": true,
"unique": true,
"kind": "<string>"
}
],
"name": "<string>",
"schema": "<string>",
"comment": "<string>",
"size_bytes": 123
}Authorizations
Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.
Response
Table described
Planner estimate; -1 when unknown.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Table description from the source's own doc mechanism.
Total on-disk size (data + indexes) in bytes, when the source reports one.