Run SQL
Execute a read-only SQL query against a database and its linked tables.
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.
Limits
Authorizations
Enter your Zite API key. Format: Bearer <api_key>
Path Parameters
The unique identifier of the database
Body
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.
50000Ordered bind values for the $1, $2, ... placeholders in sql.
1000A JSON value (string, number, boolean, or null) bound to the matching $1, $2, ... placeholder.
Per-statement timeout in milliseconds. Defaults to 10000 (10 seconds). Capped at 60000 (60 seconds).
1 <= x <= 60000Response
Query results
The result rows. Each row is an object keyed by result column name.
Ordered metadata describing each result column.
The number of rows returned (after any truncation).
True when the result exceeded the 2000-row cap and was truncated. Narrow the query or add a LIMIT to avoid truncation.