Skip to main content
POST
POST /projects/{project}/query
Runs one read-only SQL statement.

Endpoint details

string
required
Bearer pat_... (Project API Token). Keep this token on your backend/server.
string
required
Project slug. This acts as the Project ID in API paths.
boolean
required
true for a successful response and false for an error response.
object | null
Endpoint-specific response data when ok is true; null on errors.
object | null
Error code and message when ok is false; null on success.
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:
Full request:

Response examples

Success:
Error or alternate response: