TeamGriddeveloper
TeamGrid Developer

Choose an interface

Decide whether a TeamGrid integration should use API v1, the TypeScript SDK, the CLI, or the MCP server.

API v1 is the source of truth. The SDK, CLI, and MCP server are clients of that API rather than independent integration surfaces.

Need Recommended interface Why
A production service in any language API v1 Versioned HTTP contract and explicit scopes
A Node.js or TypeScript service TypeScript SDK Typed resources, retries, timeouts, and pagination
Shell scripts, CI, or an operator workflow CLI Structured output and stable exit codes
A durable resource mirror API v1 or TypeScript SDK Cell-local checkpoint-before-snapshot synchronization
Supervised work from a supported AI host MCP server Explicit read/write profiles; release availability and permissions apply
An existing integration that already uses v0 API v0 Compatibility only; plan a migration

Build automation against API v1 or the SDK. Use the CLI as an operator and scripting interface. Use MCP for human-supervised business workflows with explicit targets and approvals.

For durable mirrors, create a cell-local checkpoint before the initial snapshot, then consume the change feed for ordered catch-up. Signed webhooks remain useful low-latency delivery signals, but they are not a replayable history.

Local MCP uses the CLI credential store. The remote 1.2.2 server uses resource-bound OAuth and a separate short API delegation. Every request retains current scope, workspace and region checks. See release availability.

Continue with the customer learning path for the chosen interface and complete the production go-live checklist before enabling customer data.

Stable documentation · Developer Experience · Reviewed 2026-10-01Edit this page ↗
Documentation feedbackWas this page useful?
Esc

Search TeamGrid Developer

Find guides, concepts and every API operation.