Welcome to TeamGrid Developer

Build dependable integrations with TeamGrid API v1, the official TypeScript SDK, the CLI, and the TeamGrid MCP server.

Stable contract: API v1 · 1.0.0
Reference: 206 operations
Production regions: Germany and United States

Choose an interface

API, SDK, CLI and MCP use the same regional credentials, scopes and resource semantics. Choose the interface that fits where your integration runs; you do not need to learn a second TeamGrid platform.

HTTP · OpenAPI 3.1

API v1

Use the stable regional HTTP contract directly from a service, product integration or generated client.

Read the API overview @teamgrid/api-client

TypeScript SDK

Work with typed resources, cursor iteration and bounded retries without rebuilding the HTTP layer.

Open the SDK guide @teamgrid/cli

CLI

Inspect workspace data and run repeatable TeamGrid operations locally or from a CI pipeline.

Install the CLI @teamgrid/mcp-server

MCP server

Expose a deliberately bounded TeamGrid tool surface to compatible, supervised assistants.

Review MCP access

Make the first request

Begin with the read-only workspace endpoint. It confirms that the credential is valid, reaches the correct production region and can access the expected TeamGrid workspace.

1
Create a scoped credential
Open Developer settings in TeamGrid and grant workspace:read.
2
Store the token outside source code
Use an environment variable or the profile store provided by the TeamGrid CLI.
3
Call the regional endpoint
A successful response identifies the workspace, region and API contract.

Read-only request200 OK

curl --fail-with-body \
  --header "Authorization: Bearer $TEAMGRID_API_TOKEN" \
  https://api.de.teamgrid.app/v1/workspace

workspace:readOpen the quickstart →

Build a real workflow

The implementation guides continue beyond a successful example request. They cover permissions, pagination, retries, verification and the failure cases that matter in production.

Prepare for production

Credentials carry a region and explicit scopes. Writes use idempotency keys or resource revisions where the operation requires them. Keep those boundaries visible in your implementation from the beginning.