---
title: "Read with SQL, as the builder"
description: "One SELECT over one table of the app, every row."
canonical: "https://grid82.com/docs/builder-api/data/sql-query"
updated: "2026-11-13"
---

# Read with SQL, as the builder

`POST https://studio.grid82.app/v1/apps/{appId}/sql/query`

One SELECT over one table of the app, every row.

The dialect: SELECT \<columns or aggregates> FROM \<table> \[WHERE …] \[GROUP BY …] \[ORDER BY …] \[LIMIT n OFFSET m]; UPDATE \<table> SET col = expr \[WHERE …]; DELETE FROM \<table> \[WHERE …]. One table per statement; field names or ids (double-quote names with spaces); 'text', numbers, TRUE, FALSE, NULL, CURRENT\_DATE; AND OR NOT, = \<> \< \<= > >=, \[NOT] LIKE, \[NOT] IN (…), IS \[NOT] NULL, \[NOT] BETWEEN, CASE WHEN cond THEN v … \[ELSE v] END and CASE expr WHEN value THEN v … \[ELSE v] END; a select takes its choice's label (any case) or id; functions LENGTH LOWER UPPER TRIM ABS ROUND COALESCE SUBSTR DATE STRFTIME IFNULL INSTR REPLACE; link columns: col HAS ANY ('id', …), col HAS ALL (…), col IS EMPTY. Your text is never executed: it is compiled against your own permissions, and a column you may not read is simply an unknown column.

Requires the `records:read` scope. Operation `apps.sql.query`. MCP tool `apps_sql_query`. CLI: `grid82 apps sql query` (`npx grid82`).

## Path parameters

| Name    | Type   | Required | Description |
| ------- | ------ | -------- | ----------- |
| `appId` | string | yes      |             |

## Headers

| Name              | Type   | Required | Description                                                                                                                                                                                                                                                        |
| ----------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Idempotency-Key` | string | no       | Any unique string. Sending the same key with the same request again returns the first response (marked `Idempotency-Replayed: true`) instead of running it twice. Reusing it for a different request is refused with 409. Kept for 24 hours. Up to 255 characters. |

## Request body

| Field | Type   | Required | Description             |
| ----- | ------ | -------- | ----------------------- |
| `sql` | string | yes      | Up to 20000 characters. |

**Authorizations**

- `Authorization` (bearer, in header, required)

## Response

**200**: Success

- `data` (`object`, required)
- `data.kind` (`string`, required)
- `data.columns` (`string[]`, required)
- `data.rows` (`object[][]`, required)
- `data.rowCount` (`integer`, required)
- `data.truncated` (`boolean`, required)

```json
{
  "data": {
    "kind": "<string>",
    "columns": [
      "<string>"
    ],
    "rows": [
      [
        null
      ]
    ],
    "rowCount": 123,
    "truncated": true
  }
}
```

**4XX**: Refused

- `error` (`object`, required)
- `error.code` (`enum<string>`, required, one of: `not_found, forbidden, unauthenticated, validation_failed, conflict, rate_limited, payment_required, not_implemented, internal`)
- `error.message` (`string`, required)
- `error.details` (`Record<string, unknown>`)

```json
{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}
```

**Example request**

```bash
curl --request POST \
  --url 'https://studio.grid82.app/v1/apps/<appId>/sql/query' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sql": "<string>"
}'
```