Grid82
grid82.comJoin the waitlist
Get startedDeveloper quickstart

Developer quickstart

Create an API key or sign in with the CLI, inspect your readable schema, list records, and write a record with an idempotency key.

You can interact with any Grid82 app over REST or with the grid82 CLI. Every request runs as you and obeys your exact role permissions.

Get a credential

Install or run @grid82/cli (Node.js 22.12 or later) and sign in to your suite:

Terminal
npm install --global @grid82/cli
grid82 auth login --target https://your-suite.grid82.app --plane app

If you are on a headless machine without a browser, add --device to use the OAuth device code flow.

In your Runtime app, open the app menu, click Settings, go to Connections, and select For developers. Create a key with records:read and records:write, copy it (keys start with g82_ and are shown once), and export it:

Terminal
export GRID82_TOKEN="g82_live_..."
export GRID82_APP="https://your-suite.grid82.app/your-app"

Inspect the tables and fields you can read

curl
curl "$GRID82_APP/v1/schema" \
  -H "Authorization: Bearer $GRID82_TOKEN"
CLI
grid82 schema get --app "$GRID82_APP"

The response returns every table you may read, with permanent IDs (tbl_... and fld_...), field types, and select options. Always key automated code on IDs rather than display names, because display names can change.

List records

curl
curl "$GRID82_APP/v1/tables/tbl_8fj3kq2wmv5d/records?limit=5" \
  -H "Authorization: Bearer $GRID82_TOKEN"
CLI
grid82 records list tbl_8fj3kq2wmv5d --limit 5 --app "$GRID82_APP"

Records use field IDs as keys, and meta.fields includes the current ID-to-name map for rendering labels without a second request:

JSON
{
  "data": [
    {
      "id": "rec_4nqw8e2hzk7s",
      "fld_3ns8wq5ke2pb": "Northwind Enterprise Renewal",
      "fld_7qk2mv9xp4ht": 48000
    }
  ],
  "meta": {
    "nextCursor": "eyJ...",
    "hasMore": true,
    "fields": {
      "fld_3ns8wq5ke2pb": "Name",
      "fld_7qk2mv9xp4ht": "Amount"
    }
  }
}

Create a record safely with an idempotency key

Pass an Idempotency-Key header on POST writes so retried requests replay the original result instead of duplicating records. When writing records, you can pass either field IDs or exact field names:

curl
curl -X POST "$GRID82_APP/v1/tables/tbl_8fj3kq2wmv5d/records" \
  -H "Authorization: Bearer $GRID82_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"records":[{"Name":"Meridian Annual Support","Amount":24000}]}'
CLI
grid82 records create tbl_8fj3kq2wmv5d \
  --records '[{"Name":"Meridian Annual Support","Amount":24000}]' \
  --app "$GRID82_APP"

Fetch your personal OpenAPI spec

An app’s OpenAPI spec is generated per caller and excludes hidden tables and fields:

Terminal
curl "$GRID82_APP/v1/openapi.json" \
  -H "Authorization: Bearer $GRID82_TOKEN" > app-openapi.json

Next steps

Use these docs with your AI tools

An AI agent can read this documentation directly. You do not need an account or an API key. Everything here is public and read-only.

Query these docs via MCP

Recommended

Add this server to Claude, Claude Code, Cursor, Mistral, or any tool that supports MCP. Your agent can then search Grid82 documentation and read it in full, instead of answering from memory.

https://grid82.com/docs/mcp
  • searchFind the passages that answer a question.
  • fetchRead one page in full, as Markdown.
  • list_pagesSee every page in this documentation.

Query these docs over HTTP

The same tools also work as plain web requests. Use this for scripts, or for any tool that does not support MCP. There is one endpoint per tool. Arguments go in the query string, and the answer comes back as JSON.

https://grid82.com/docs/api/docs/search?query=custom+domain

Read the OpenAPI description. It is built from the same definitions as the tools, so it always matches what the endpoints do.

Read these docs as Markdown

Add .md to any page URL to get its Markdown source. You can also send the headerAccept: text/markdown to the page URL itself.

To read the whole documentation in one file, open llms-full.txt. For a short index of every page, open llms.txt.