Skip to main content
POST
Query SQL

Authorizations

Authorization
string
header
required

This API uses OAuth 2.0 with the authorization code grant flow.

Body

application/json
sql
string
required

The SQL query to be executed. Use $name placeholders to reference values from parameters instead of inlining them into the query.

Example:

"SELECT * FROM companies WHERE (name = $name OR name = ANY($names)) AND created_at >= $since"

parameters
object

Named parameters referenced in the query using $name syntax. A maximum of 25 parameters can be provided. Each parameter must declare its type explicitly. Names must start with a letter or underscore, only contain letters, digits and underscores, and be at most 64 characters long. Compare against a list parameter with = ANY($name), not IN ($name), which does not type check. Read a field of a struct parameter with get_field($name, 'field').

Example:

Response

Success

Success

data
object
required
Example: