SQL
Run SQL
Execute a read-only SQL query against a database and its linked tables.
POST
/
bases
/
{databaseId}
/
sql
Run SQL query
curl --request POST \
--url https://tables.zite.com/api/v1/bases/{databaseId}/sql \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sql": "SELECT \"Name\", \"Amount\" FROM \"Orders\" WHERE \"Status\" = $1 ORDER BY \"Amount\" DESC",
"params": [
"Paid"
]
}
'import requests
url = "https://tables.zite.com/api/v1/bases/{databaseId}/sql"
payload = {
"sql": "SELECT \"Name\", \"Amount\" FROM \"Orders\" WHERE \"Status\" = $1 ORDER BY \"Amount\" DESC",
"params": ["Paid"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sql: 'SELECT "Name", "Amount" FROM "Orders" WHERE "Status" = $1 ORDER BY "Amount" DESC',
params: ['Paid']
})
};
fetch('https://tables.zite.com/api/v1/bases/{databaseId}/sql', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sql' => 'SELECT "Name", "Amount" FROM "Orders" WHERE "Status" = $1 ORDER BY "Amount" DESC',
'params' => [
'Paid'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://tables.zite.com/api/v1/bases/{databaseId}/sql"
payload := strings.NewReader("{\n \"sql\": \"SELECT \\\"Name\\\", \\\"Amount\\\" FROM \\\"Orders\\\" WHERE \\\"Status\\\" = $1 ORDER BY \\\"Amount\\\" DESC\",\n \"params\": [\n \"Paid\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://tables.zite.com/api/v1/bases/{databaseId}/sql")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sql\": \"SELECT \\\"Name\\\", \\\"Amount\\\" FROM \\\"Orders\\\" WHERE \\\"Status\\\" = $1 ORDER BY \\\"Amount\\\" DESC\",\n \"params\": [\n \"Paid\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://tables.zite.com/api/v1/bases/{databaseId}/sql")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sql\": \"SELECT \\\"Name\\\", \\\"Amount\\\" FROM \\\"Orders\\\" WHERE \\\"Status\\\" = $1 ORDER BY \\\"Amount\\\" DESC\",\n \"params\": [\n \"Paid\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"rows": [
{}
],
"columns": [
{
"name": "<string>",
"originalName": "<string>",
"type": "number"
}
],
"rowCount": 123,
"truncated": true
}
Queries are read-only. Only
SELECT statements are permitted. Any write, DDL, or transaction-control statement is rejected.Writing queries
- Human-readable names. Reference tables and fields by the same names you see in the Zite SDK, not physical column names (e.g.
SELECT "Name" FROM "Orders"). - Bind parameters. Pass user-supplied values in
paramsand reference them with positional placeholders ($1,$2, …). This is safer than interpolating values into the SQL string. - Linked records. Join through link tables to traverse relationships. Use Get SQL Schema to discover table names, field names, and link tables.
{
"sql": "SELECT \"Name\", \"Amount\" FROM \"Orders\" WHERE \"Status\" = $1 ORDER BY \"Amount\" DESC",
"params": ["Paid"]
}
Limits
| Behavior | Detail |
|---|---|
| Row cap | Results are capped at ~2000 rows. When more match, truncated is true and only the first 2000 rows are returned. |
| Timeout | statementTimeoutMs defaults to 10000 (10 seconds) and is capped at 60000 (60 seconds). |
| Query size | The sql string may be up to 50,000 characters; params accepts up to 1000 values. |
If
truncated is true, narrow the query with a WHERE clause or add your own LIMIT/OFFSET to page through results.Body
application/json
The read-only SELECT statement to execute. Reference tables and fields by their human-readable names (the same names used by the Zite SDK), not physical column names. Bind user-supplied values with positional placeholders ($1, $2, ...) rather than string interpolation.
Maximum string length:
50000Response
Query results
⌘I
Run SQL query
curl --request POST \
--url https://tables.zite.com/api/v1/bases/{databaseId}/sql \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sql": "SELECT \"Name\", \"Amount\" FROM \"Orders\" WHERE \"Status\" = $1 ORDER BY \"Amount\" DESC",
"params": [
"Paid"
]
}
'import requests
url = "https://tables.zite.com/api/v1/bases/{databaseId}/sql"
payload = {
"sql": "SELECT \"Name\", \"Amount\" FROM \"Orders\" WHERE \"Status\" = $1 ORDER BY \"Amount\" DESC",
"params": ["Paid"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sql: 'SELECT "Name", "Amount" FROM "Orders" WHERE "Status" = $1 ORDER BY "Amount" DESC',
params: ['Paid']
})
};
fetch('https://tables.zite.com/api/v1/bases/{databaseId}/sql', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sql' => 'SELECT "Name", "Amount" FROM "Orders" WHERE "Status" = $1 ORDER BY "Amount" DESC',
'params' => [
'Paid'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://tables.zite.com/api/v1/bases/{databaseId}/sql"
payload := strings.NewReader("{\n \"sql\": \"SELECT \\\"Name\\\", \\\"Amount\\\" FROM \\\"Orders\\\" WHERE \\\"Status\\\" = $1 ORDER BY \\\"Amount\\\" DESC\",\n \"params\": [\n \"Paid\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://tables.zite.com/api/v1/bases/{databaseId}/sql")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sql\": \"SELECT \\\"Name\\\", \\\"Amount\\\" FROM \\\"Orders\\\" WHERE \\\"Status\\\" = $1 ORDER BY \\\"Amount\\\" DESC\",\n \"params\": [\n \"Paid\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://tables.zite.com/api/v1/bases/{databaseId}/sql")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sql\": \"SELECT \\\"Name\\\", \\\"Amount\\\" FROM \\\"Orders\\\" WHERE \\\"Status\\\" = $1 ORDER BY \\\"Amount\\\" DESC\",\n \"params\": [\n \"Paid\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"rows": [
{}
],
"columns": [
{
"name": "<string>",
"originalName": "<string>",
"type": "number"
}
],
"rowCount": 123,
"truncated": true
}