---
title: "Read the schema you can see"
description: "Returns the tables and fields your permissions allow."
canonical: "https://grid82.com/docs/app-api/schema/get"
updated: "2026-11-13"
---

# Read the schema you can see

`GET https://your-suite.grid82.app/your-app/v1/schema`

Returns the tables and fields your permissions allow.

> **Note: Generic contract**
>
> Your own version of this operation, with your tables and the fields you can read, is in
> your app's document: `https://{suite}.grid82.app/{app}/v1/openapi.json`, behind your credential.
> [Why each person gets their own](/docs/start/studio-and-runtime#why-an-app-has-an-api-of-its-own).

A field you cannot read is absent. It is not listed as hidden, because listing it would leak it.

Requires the `schema:read` scope. Operation `schema.get`. MCP tool `schema_get`. CLI: `grid82 schema get` (`npx grid82`).

**Authorizations**

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

## Response

**200**: Success

- `data` (`object`, required)
- `data.tables` (`object[]`, required)
- `data.tables.id` (`string`, required, pattern: `^[a-z][a-z0-9_]{0,62}$`)
- `data.tables.name` (`string`, required, length: `1–120 chars`)
- `data.tables.plural` (`string`, length: `1–120 chars`)
- `data.tables.description` (`string`, length: `≤ 2000 chars`)
- `data.tables.icon` (`string | null`)
- `data.tables.primaryFieldId` (`string`, required, pattern: `^[a-z][a-z0-9_]{0,62}$`)
- `data.tables.fields` (`object[]`, required, items: `1–200 items`)
- `data.tables.fields.id` (`string`, required, pattern: `^[a-z][a-z0-9_]{0,62}$`)
- `data.tables.fields.name` (`string`, required, length: `1–120 chars`)
- `data.tables.fields.width` (`integer`, range: `60–900`)
- `data.tables.fields.type` (`string`, required)
- `data.tables.fields.config` (`object`, required, default: `{}`)

```json
{
  "data": {
    "tables": [
      {
        "id": "<string>",
        "name": "<string>",
        "plural": "<string>",
        "description": "<string>",
        "icon": "<string>",
        "primaryFieldId": "<string>",
        "fields": [
          {
            "id": "<string>",
            "name": "<string>",
            "width": 123,
            "type": "<string>",
            "config": {}
          }
        ]
      }
    ]
  }
}
```

**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 GET \
  --url 'https://your-suite.grid82.app/your-app/v1/schema' \
  --header 'Authorization: Bearer <token>'
```