Read the schema you can see

Returns the tables and fields your permissions allow.

GET/v1/schema

Request

curl --request GET \
  --url 'https://your-suite.grid82.app/your-app/v1/schema' \
  --header 'Authorization: Bearer <token>'

import json
import requests

url = "https://your-suite.grid82.app/your-app/v1/schema"
headers = {
  "Authorization": "Bearer <token>"
}

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

const response = await fetch("https://your-suite.grid82.app/your-app/v1/schema", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  },
});

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

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://your-suite.grid82.app/your-app/v1/schema");
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://your-suite.grid82.app/your-app/v1/schema", 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://your-suite.grid82.app/your-app/v1/schema"))
    .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://your-suite.grid82.app/your-app/v1/schema")
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": {
    "tables": [
      {
        "id": "<string>",
        "name": "<string>",
        "plural": "<string>",
        "description": "<string>",
        "icon": "<string>",
        "primaryFieldId": "<string>",
        "fields": [
          {
            "id": "<string>",
            "name": "<string>",
            "width": 123,
            "type": "<string>",
            "config": {}
          }
        ]
      }
    ]
  }
}

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

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).

Response

application/json

Success

dataobjectrequired

Show child attributes

data.tablesobject[]required

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": { "tables": [ { "id": "<string>", "name": "<string>", "plural": "<string>", "description": "<string>", "icon": "<string>", "primaryFieldId": "<string>", "fields": [ { "id": "<string>", "name": "<string>", "width": 123, "type": "<string>", "config": {} } ] } ] } }

Read the schema you can see

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown