Read an app definition

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

GET/v1/apps/{appId}

Request

curl --request GET \
  --url 'https://studio.grid82.app/v1/apps/<appId>' \
  --header 'Authorization: Bearer <token>'

import json
import requests

url = "https://studio.grid82.app/v1/apps/<appId>"
headers = {
  "Authorization": "Bearer <token>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://studio.grid82.app/v1/apps/<appId>", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.grid82.app/v1/apps/<appId>");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://studio.grid82.app/v1/apps/<appId>", nil)
  req.Header.Set("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://studio.grid82.app/v1/apps/<appId>"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://studio.grid82.app/v1/apps/<appId>")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/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>"
  }
}

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

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

Response

application/json

Success

dataobjectrequired

Show child attributes

data.schemaVersionnumberrequired

data.idstringrequiredlength: 1–64 chars

data.namestringrequiredlength: 1–120 chars

data.slugstringrequiredpattern: ^[a-z0-9][a-z0-9-]{1,62}$

data.tablesobject[]requireditems: ≤ 200 items

Show child attributes

data.tables.idstringrequiredpattern: ^[a-z][a-z0-9_]{0,62}$

data.tables.namestringrequiredlength: 1–120 chars

data.tables.pluralstringlength: 1–120 chars

data.tables.descriptionstringlength: ≤ 2000 chars

data.tables.iconstring | null

data.tables.primaryFieldIdstringrequiredpattern: ^[a-z][a-z0-9_]{0,62}$

data.tables.fieldsobject[]requireditems: 1–200 items

Show child attributes

data.tables.fields.idstringrequiredpattern: ^[a-z][a-z0-9_]{0,62}$

data.tables.fields.namestringrequiredlength: 1–120 chars

data.tables.fields.widthintegerrange: 60–900

data.tables.fields.typestringrequired

data.tables.fields.configobjectrequireddefault: {}

data.viewsRecord<string, object[]>requireddefault: {}

data.rulesobjectrequired

Show child attributes

data.rules.versionnumberrequired

data.rules.rolesobject[]requireditems: 1–100 items

Show child attributes

data.rules.roles.idstringrequiredpattern: ^[a-z][a-z0-9_]{0,62}$

data.rules.roles.namestringrequiredlength: 1–120 chars

data.rules.roles.descriptionstringlength: ≤ 500 chars

data.rules.roles.assistantMonthlyCreditsintegerrange: 0–10000000

data.rules.roles.interfaceenum<string>one of: assigned, own

data.rules.roles.automationsenum<string>one of: none, own

data.rules.permissionsobject[]requireditems: ≤ 100 items

Show child attributes

data.rules.permissions.rolestringrequiredpattern: ^[a-z][a-z0-9_]{0,62}$

data.rules.permissions.tablesstring | Record<string, object>required

data.pagesobject[]requireddefault: []

Show child attributes

data.pages.idstringrequiredlength: 1–64 chars

data.pages.namestringrequiredlength: 1–120 chars

data.pages.kindenum<string>requiredone of: declarative, code

data.pages.modeenum<string>requiredone of: locked, template, canvas

data.pages.ownerenum<string>requiredone of: admin, user

data.pages.ownerUserIdstringlength: ≤ 64 chars

data.pages.tableIdstringpattern: ^[a-z][a-z0-9_]{0,62}$

data.pages.forkedFromstringlength: ≤ 64 chars

data.pages.visibleTostring | string[]requireddefault: *

data.pages.readsobject

Show child attributes

data.pages.reads.tablesstring[]requireddefault: []

data.pages.reads.fieldsstring[]requireddefault: []

data.pages.reads.viewsstring[]requireddefault: []

data.pages.bundleHashstringlength: ≤ 128 chars

data.pages.publishedVersionintegerrange: ≥ 1

data.pages.themeobject

Show child attributes

data.pages.theme.accentstringpattern: ^(?:#[0-9a-fA-F]{3,8}|oklch$[0-9.%\s/]{1,60}$)$

data.pages.theme.radiusnumberrange: 0–24

data.pages.documentobject

data.pages.versionintegerrequireddefault: 1range: ≥ 1

data.pages.updatedAtstringrequired

data.membersobject[]requireddefault: []

Show child attributes

data.members.userIdstringrequiredlength: 1–64 chars

data.members.emailstring<email>requiredpattern: ^(?:[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.namestringlength: ≤ 120 chars

data.members.rolesstring[]requireditems: ≥ 1 items

data.members.statusenum<string>requireddefault: invitedone of: invited, active, suspended

data.members.invitedAtstring

data.themeobjectrequireddefault: {"radius":6,"accent":"oklch(0.47 0.16 262)","font":"inter"}

Show child attributes

data.theme.radiusnumberrequireddefault: 6range: 0–24

data.theme.accentstringrequireddefault: oklch(0.47 0.16 262)pattern: ^(?:#[0-9a-fA-F]{3,8}|oklch$[0-9.%\s/]{1,60}$)$

data.theme.fontenum<string>requireddefault: interone 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.iconstring | nulldefault: null

data.surfacesobjectrequireddefault: {"data":true,"interface":true,"assistant":true,"api":true,"mcp":true,"cli":true}

Show child attributes

data.surfaces.databooleanrequireddefault: true

data.surfaces.interfacebooleanrequireddefault: true

data.surfaces.assistantbooleanrequireddefault: true

data.surfaces.apibooleanrequireddefault: true

data.surfaces.mcpbooleanrequireddefault: true

data.surfaces.clibooleanrequireddefault: true

data.updatedAtstringrequired

{ "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>" } }

Read an app definition

Path parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown