Data SQL Query

Run SQL query against workspace data

POST/api/v1/data/sql-query

Executes a read-only PostgreSQL SELECT query against workspace data definitions projected as queryable tables. The query must reference a current workspace definition handle or its generated snake_case alias; bare table names only work when they match an existing definition.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

sql*nonEmptyString

a non empty string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://loading/api/v1/data/sql-query" \  -H "Content-Type: application/json" \  -d '{    "sql": "SELECT id, email, created_at FROM customer ORDER BY created_at DESC LIMIT 10"  }'

{
  "sql": "SELECT id, email, created_at FROM customer ORDER BY created_at DESC LIMIT 10",
  "normalizedSql": "SELECT id, email, created_at FROM customer ORDER BY created_at DESC LIMIT 10",
  "usedTables": [
    "customer"
  ],
  "table": {
    "columns": [
      "id",
      "email",
      "created_at"
    ],
    "rows": [
      [
        "rec_123",
        "jane@example.com",
        "2026-03-17T10:00:00.000Z"
      ]
    ]
  },
  "records": [
    {
      "id": "rec_123",
      "email": "jane@example.com",
      "created_at": "2026-03-17T10:00:00.000Z"
    }
  ],
  "ascii": "+---------+------------------+---------------------------+\n| id      | email            | created_at                |\n+---------+------------------+---------------------------+\n| rec_123 | jane@example.com | 2026-03-17T10:00:00.000Z |\n+---------+------------------+---------------------------+\n(1 row shown, limit 10)",
  "rowCount": 1,
  "executionTimeMs": 12,
  "truncated": false,
  "cached": false,
  "warnings": []
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

{
  "code": "authentication_required",
  "message": "Authentication required. Send Authorization: Bearer <api-key>, x-api-key, or a signed-in session."
}

{
  "code": "insufficient_permissions",
  "message": "This API key does not have data.read permission.",
  "details": {
    "requiredPermission": "data.read"
  }
}

{
  "code": "internal_error",
  "message": "An unexpected server error occurred."
}

Data SQL Query

Run SQL query against workspace data

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`