---
title: "Read an app definition"
description: "The whole definition: tables, views, rules, pages, members, theme, surfaces."
canonical: "https://grid82.com/docs/builder-api/apps/get"
updated: "2026-11-13"
---

# Read an app definition

`GET https://studio.grid82.app/v1/apps/{appId}`

The whole definition: tables, views, rules, pages, members, theme, surfaces.

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

## Path parameters

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

**Authorizations**

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

## Response

**200**: Success

- `data` (`object`, required)
- `data.schemaVersion` (`number`, required)
- `data.id` (`string`, required, length: `1–64 chars`)
- `data.name` (`string`, required, length: `1–120 chars`)
- `data.slug` (`string`, required, pattern: `^[a-z0-9][a-z0-9-]{1,62}$`)
- `data.tables` (`object[]`, required, items: `≤ 200 items`)
- `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: `{}`)
- `data.views` (`Record<string, object[]>`, required, default: `{}`)
- `data.rules` (`object`, required)
- `data.rules.version` (`number`, required)
- `data.rules.roles` (`object[]`, required, items: `1–100 items`)
- `data.rules.roles.id` (`string`, required, pattern: `^[a-z][a-z0-9_]{0,62}$`)
- `data.rules.roles.name` (`string`, required, length: `1–120 chars`)
- `data.rules.roles.description` (`string`, length: `≤ 500 chars`)
- `data.rules.roles.assistantMonthlyCredits` (`integer`, range: `0–10000000`)
- `data.rules.roles.interface` (`enum<string>`, one of: `assigned, own`)
- `data.rules.roles.automations` (`enum<string>`, one of: `none, own`)
- `data.rules.permissions` (`object[]`, required, items: `≤ 100 items`)
- `data.rules.permissions.role` (`string`, required, pattern: `^[a-z][a-z0-9_]{0,62}$`)
- `data.rules.permissions.tables` (`string | Record<string, object>`, required)
- `data.pages` (`object[]`, required, default: `[]`)
- `data.pages.id` (`string`, required, length: `1–64 chars`)
- `data.pages.name` (`string`, required, length: `1–120 chars`)
- `data.pages.kind` (`enum<string>`, required, one of: `declarative, code`)
- `data.pages.mode` (`enum<string>`, required, one of: `locked, template, canvas`)
- `data.pages.owner` (`enum<string>`, required, one of: `admin, user`)
- `data.pages.ownerUserId` (`string`, length: `≤ 64 chars`)
- `data.pages.tableId` (`string`, pattern: `^[a-z][a-z0-9_]{0,62}$`)
- `data.pages.forkedFrom` (`string`, length: `≤ 64 chars`)
- `data.pages.visibleTo` (`string | string[]`, required, default: `*`)
- `data.pages.reads` (`object`)
- `data.pages.reads.tables` (`string[]`, required, default: `[]`)
- `data.pages.reads.fields` (`string[]`, required, default: `[]`)
- `data.pages.reads.views` (`string[]`, required, default: `[]`)
- `data.pages.bundleHash` (`string`, length: `≤ 128 chars`)
- `data.pages.publishedVersion` (`integer`, range: `≥ 1`)
- `data.pages.theme` (`object`)
- `data.pages.theme.accent` (`string`, pattern: `^(?:#[0-9a-fA-F]{3,8}|oklch\([0-9.%\s/]{1,60}\))$`)
- `data.pages.theme.radius` (`number`, range: `0–24`)
- `data.pages.document` (`object`)
- `data.pages.version` (`integer`, required, default: `1`, range: `≥ 1`)
- `data.pages.updatedAt` (`string`, required)
- `data.members` (`object[]`, required, default: `[]`)
- `data.members.userId` (`string`, required, length: `1–64 chars`)
- `data.members.email` (`string<email>`, required, pattern: `^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$`)
- `data.members.name` (`string`, length: `≤ 120 chars`)
- `data.members.roles` (`string[]`, required, items: `≥ 1 items`)
- `data.members.status` (`enum<string>`, required, default: `invited`, one of: `invited, active, suspended`)
- `data.members.invitedAt` (`string`)
- `data.theme` (`object`, required, default: `{"radius":6,"accent":"oklch(0.47 0.16 262)","font":"inter"}`)
- `data.theme.radius` (`number`, required, default: `6`, range: `0–24`)
- `data.theme.accent` (`string`, required, default: `oklch(0.47 0.16 262)`, pattern: `^(?:#[0-9a-fA-F]{3,8}|oklch\([0-9.%\s/]{1,60}\))$`)
- `data.theme.font` (`enum<string>`, required, default: `inter`, one of: `system, geist, inter, figtree, manrope, jakarta, dm-sans, outfit, work-sans, nunito-sans, rubik, public-sans, source-serif, lora, fraunces, instrument-serif, geist-mono, jetbrains-mono, ibm-plex-mono`)
- `data.theme.icon` (`string | null`, default: `null`)
- `data.surfaces` (`object`, required, default: `{"data":true,"interface":true,"assistant":true,"api":true,"mcp":true,"cli":true}`)
- `data.surfaces.data` (`boolean`, required, default: `true`)
- `data.surfaces.interface` (`boolean`, required, default: `true`)
- `data.surfaces.assistant` (`boolean`, required, default: `true`)
- `data.surfaces.api` (`boolean`, required, default: `true`)
- `data.surfaces.mcp` (`boolean`, required, default: `true`)
- `data.surfaces.cli` (`boolean`, required, default: `true`)
- `data.updatedAt` (`string`, required)

```json
{
  "data": {
    "schemaVersion": 123.45,
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "tables": [
      {
        "id": "<string>",
        "name": "<string>",
        "plural": "<string>",
        "description": "<string>",
        "icon": "<string>",
        "primaryFieldId": "<string>",
        "fields": [
          {
            "id": "<string>",
            "name": "<string>",
            "width": 123,
            "type": "<string>",
            "config": {}
          }
        ]
      }
    ],
    "views": {},
    "rules": {
      "version": 123.45,
      "roles": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "assistantMonthlyCredits": 123,
          "interface": "assigned",
          "automations": "none"
        }
      ],
      "permissions": [
        {
          "role": "<string>",
          "tables": "<string>"
        }
      ]
    },
    "pages": [],
    "members": [],
    "theme": {
      "radius": 6,
      "accent": "oklch(0.47 0.16 262)",
      "font": "inter"
    },
    "surfaces": {
      "data": true,
      "interface": true,
      "assistant": true,
      "api": true,
      "mcp": true,
      "cli": true
    },
    "updatedAt": "<string>"
  }
}
```

**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://studio.grid82.app/v1/apps/<appId>' \
  --header 'Authorization: Bearer <token>'
```