Grid82
grid82.comJoin the waitlist
DevelopersOverview

REST API overview

Compare the Studio Builder API and per-app Runtime API, fetch per-caller OpenAPI documents, and see how builders reach app records.

Grid82 exposes two REST APIs built from the same route registry as the CLI and MCP servers. Both share identical response envelopes, cursor pagination, error codes, idempotency semantics, and contract versioning.

Builder API (Studio)App API (Runtime)
Base URLhttps://studio.grid82.app/v1https://{suite}.grid82.app/{app}/v1
ManagesOrganisations, suites, apps, tables, fields, roles, users, domains, pages, workflowsRecords, views, comments, files, SQL queries, approvals, personal pages/workflows, events
CredentialsStudio builder keys and Studio OAuth grantsApp keys (Settings -> Connections) and suite OAuth grants
OpenAPI specPublic: https://studio.grid82.app/v1/openapi.jsonPer caller: https://{suite}.grid82.app/{app}/v1/openapi.json
ReferenceBuilder APIApp API

Suites attached to custom hostnames serve the App API directly on that hostname (for example https://portal.yourcompany.com/crm/v1).

Per-caller OpenAPI for apps

An app’s OpenAPI document is generated dynamically for the authenticated caller:

  • tableId enumerations include only tables your roles can open.
  • Record payload schemas list only the fields you are allowed to read and edit.
  • Unauthenticated calls to /{app}/v1/openapi.json return 401.

Because of this, the App API reference in these docs presents the generic contract without app-specific tables or columns. To generate a strongly typed client for your own app and role, download your caller-specific spec:

Terminal
curl "https://your-suite.grid82.app/your-app/v1/openapi.json" \
  -H "Authorization: Bearer $GRID82_TOKEN" > app-openapi.json

Generic OpenAPI specs are also hosted statically at /docs/openapi/app.json and /docs/openapi/builder.json.

Accessing data as a builder

Builders are not automatic members of their apps in Runtime, and do not need to be. Use the Builder API routes under /v1/apps/{appId}/tables/{tableId}/records and /v1/apps/{appId}/sql/* to read, query, or import data cleanly under your builder identity.

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.