Query SQL
SQL
Query SQL
Query records and lists with SQL.
This endpoint is in alpha and may be subject to breaking changes as we gather feedback.
Required scopes: record_permission:read, object_configuration:read.
POST
Query SQL
Authorizations
This API uses OAuth 2.0 with the authorization code grant flow.
Body
application/json
The SQL query to be executed.
Example:
"SELECT * FROM companies WHERE companies.name = 'Fundstack'"
Response
Success
Success
Example:
{
"rows": [
{
"record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
"created_at": "2023-01-01T15:00:00.000000000Z",
"name": "Fundstack",
"created_by": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
},
"domains": ["fundstack.com"]
}
]
}