> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zangtable.com/llms.txt
> Use this file to discover all available pages before exploring further.

# POST /projects/{project}/query

> Runs one read-only SQL statement.

Runs one read-only SQL statement.

## Endpoint details

<ParamField header="Authorization" type="string" required>
  Bearer `pat_...` (Project API Token). Keep this token on your backend/server.
</ParamField>

<ParamField path="project" type="string" required>
  Project slug. This acts as the Project ID in API paths.
</ParamField>

<ResponseField name="ok" type="boolean" required>
  `true` for a successful response and `false` for an error response.
</ResponseField>

<ResponseField name="data" type="object | null">
  Endpoint-specific response data when `ok` is `true`; `null` on errors.
</ResponseField>

<ResponseField name="error" type="object | null">
  Error code and message when `ok` is `false`; `null` on success.
</ResponseField>

<ResponseField name="request_id" type="string" required>
  Request identifier you can use when troubleshooting a specific API call.
</ResponseField>

## 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:

```bash theme={null}
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:

```bash theme={null}
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:

```json theme={null}
{
  "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:

```json theme={null}
{
  "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"
  }
}
```