Skip to main content
POST
https://api-zangtable.com
/
projects
/
{project}
/
query
POST /projects/{project}/query
curl --request POST \
  --url https://api-zangtable.com/projects/{project}/query \
  --header 'Authorization: <authorization>'
{
  "ok": true,
  "data": {},
  "error": {},
  "request_id": "<string>"
}
Runs one read-only SQL statement.

Endpoint details

Authorization
string
required
Bearer pat_... (Project API Token). Keep this token on your backend/server.
project
string
required
Project slug. This acts as the Project ID in API paths.
ok
boolean
required
true for a successful response and false for an error response.
data
object | null
Endpoint-specific response data when ok is true; null on errors.
error
object | null
Error code and message when ok is false; null on success.
request_id
string
required
Request identifier you can use when troubleshooting a specific API call.

Authentication

Project API Token.

Parameters

Body: sql or query required; params optional array or object; limit optional integer, clamped 1-1000, default 500.

Notes

Only SELECT, WITH, and EXPLAIN QUERY PLAN are accepted. Multiple statements and write/schema keywords are blocked.

Request examples

Basic request:
curl -X POST "$BASE_URL/projects/{project}/query" \
  -H 'Authorization: Bearer pat_PROJECT_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{"sql":"SELECT id, email FROM contacts LIMIT 10"}'
Full request:
curl -X POST "$BASE_URL/projects/{project}/query" \
  -H 'Authorization: Bearer pat_PROJECT_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-Operation-Key: edit-profile-email' \
  -H 'X-Operation-Run-Id: oprun_client_20260602_001' \
  --data '{"query":"SELECT id, email FROM contacts WHERE status = :status ORDER BY id DESC","params":{"status":"active"},"limit":1000}'

Response examples

Success:
{
  "ok": true,
  "data": {
    "rows": [
      {
        "id": 1,
        "email": "ada@example.com"
      }
    ],
    "row_count": 1,
    "limit": 500,
    "duration_ms": 1.42
  },
  "error": null,
  "request_id": "req_20260602T012345_123456Z_abc123def456",
  "operation_key": "edit-profile-email",
  "operation_run_id": "oprun_20260602T012300_000000Z_a1b2c3d4e5f6",
  "operation_grouping_status": "accepted_provided_run",
  "meta": {
    "generated_at": "2026-06-02T01:23:45Z"
  }
}
Error or alternate response:
{
  "ok": false,
  "data": null,
  "error": {
    "code": "write_sql_forbidden",
    "message": "This endpoint only accepts read-only SQL and does not support ATTACH, PRAGMA, writes, or schema changes."
  },
  "request_id": "req_20260602T012345_123456Z_abc123def456",
  "meta": {
    "generated_at": "2026-06-02T01:23:45Z"
  }
}