Get SQL Schema

GET

bases

{databaseId}

sql

schema

Get SQL schema

curl --request GET \
  --url https://tables.zite.com/api/v1/bases/{databaseId}/sql/schema \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://tables.zite.com/api/v1/bases/{databaseId}/sql/schema"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://tables.zite.com/api/v1/bases/{databaseId}/sql/schema', 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://tables.zite.com/api/v1/bases/{databaseId}/sql/schema",
  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://tables.zite.com/api/v1/bases/{databaseId}/sql/schema"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://tables.zite.com/api/v1/bases/{databaseId}/sql/schema")

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

{
  "tables": [
    {
      "name": "<string>",
      "primaryFieldName": "<string>",
      "fields": [
        {
          "name": "<string>",
          "type": "<string>",
          "postgresType": "<string>",
          "linksTo": "<string>",
          "options": [
            {
              "value": "<string>",
              "label": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "linkTables": [
    {
      "name": "<string>",
      "joins": [
        "<string>"
      ],
      "sourceTable": "<string>",
      "targetTable": "<string>",
      "sourceTableIdColumn": "<string>",
      "targetTableIdColumn": "<string>"
    }
  ]
}

Returns the database schema — tables, their fields, and the link tables that connect them — using human-readable names. Use this to discover the exact table and field names to reference from Run SQL.

Names in the response match the human-readable names used in your SQL queries and the Zite SDK.

Query parameters

Parameter	Type	Description
`tables`	string[]	Optional whitelist of table names to include. Repeat the parameter for multiple tables (e.g. `?tables=Orders&tables=Customers`) or pass a single comma-separated string. Omit to return all tables.
`includeFields`	boolean	Whether to include field-level detail. Defaults to `true`. Set to `false` for a cheap overview of just table names.

Link tables

linkTables describes the junction tables that connect two tables for many-to-many relationships. Each entry exposes the source and target tables along with the columns to join on, so you can traverse linked records in SQL.

Authorizations

Authorization

string

header

required

Enter your Zite API key. Format: Bearer <api_key>

Path Parameters

databaseId

string

required

The unique identifier of the database

Query Parameters

tables

string[]

Optional whitelist of table names to include. Repeat the parameter for multiple tables (or pass a single comma-separated string). Omit to return all tables.

includeFields

boolean

default:true

Whether to include field-level detail for each table. Set to false for a cheap overview of just table names.

Response

Database schema

tables

object[]

required

The tables in the database.

Show child attributes

linkTables

object[]

required

The junction tables linking tables together for many-to-many relationships.

Show child attributes

Get SQL schema

curl --request GET \
  --url https://tables.zite.com/api/v1/bases/{databaseId}/sql/schema \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://tables.zite.com/api/v1/bases/{databaseId}/sql/schema"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://tables.zite.com/api/v1/bases/{databaseId}/sql/schema', 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://tables.zite.com/api/v1/bases/{databaseId}/sql/schema",
  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://tables.zite.com/api/v1/bases/{databaseId}/sql/schema"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://tables.zite.com/api/v1/bases/{databaseId}/sql/schema")

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

{
  "tables": [
    {
      "name": "<string>",
      "primaryFieldName": "<string>",
      "fields": [
        {
          "name": "<string>",
          "type": "<string>",
          "postgresType": "<string>",
          "linksTo": "<string>",
          "options": [
            {
              "value": "<string>",
              "label": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "linkTables": [
    {
      "name": "<string>",
      "joins": [
        "<string>"
      ],
      "sourceTable": "<string>",
      "targetTable": "<string>",
      "sourceTableIdColumn": "<string>",
      "targetTableIdColumn": "<string>"
    }
  ]
}

API reference

Zite MCP (data)

Query parameters

Link tables

Authorizations

Path Parameters

Query Parameters

Response

​Query parameters

​Link tables

Authorizations

Path Parameters

Query Parameters

Response

Query parameters

Link tables