TeamGriddeveloper
TeamGrid Developer

Capability coverage

Understand how API v1 operations map to the TeamGrid SDK, CLI, and curated MCP server.

TeamGrid maintains one versioned capability contract alongside OpenAPI. It requires an SDK method, CLI command, and explicit MCP decision for every public API operation. CI fails when any surface drifts.

The stable 1.1.0 API v1 contract contains 154 paths and 237 operations. The CLI maps all 237 operations. The TypeScript SDK maps the 236 programmatic operations; the one-time anonymous CLI code exchange is deliberately CLI-only. MCP has an explicit decision for every operation: 36 bounded reads are available in the all profile, while the least-privilege core default exposes 22. Writes, destructive lifecycle operations, project statements, webhook delivery history, audit events, API discovery, and reveal-once secrets are deliberately not exposed through MCP.

The cross-interface contract currently governs workspace, projects and asynchronous project lifecycle operations, tasks, recurring tasks and timers, time entries, calendar appointments, absences, availability, contacts, comments, activity, documents, files, workspace administration, search, bounded exports, automation definitions and runs, integration-installation status, call notes, contact groups, users, metadata, custom fields, commerce resources, audit events, webhooks, delivery history, templates, and planned work, personal access credentials, service accounts, resource grants, and the durable change feed. Finance fields are scope-gated, and MCP product reads always remove acquisition cost.

The same release boundary qualifies 18 project, task, project-sharing, and project-template mutations with strong ETags and required If-Match, plus two revision-bound asynchronous-operation reads. Another 46 protected operations retain resource-specific revision formats for planned work, custom-field values, calendar data, documents, workspace administration, automations, workspace settings, and webhook-secret rotation.

Authorization registry

Transport parity is only one half of the contract. TeamGrid also maintains a code-owned action-policy registry for all 237 operations. API discovery and the one-time CLI code exchange are anonymous or public-client operations; all 235 credential-authenticated operations are bound to their App execution methods, product-permission resolvers, entitlement checks, resource-grant resolvers, conditional domain policies, sensitive field overlays, allowed principal kinds, and one of 12 principal-policy rollout families. The two current-credential self-service operations deliberately require no additional scope, but still require and revalidate the exact bearer credential, principal, workspace, region, and cell.

The current registry identity and SHA-256 are published in the machine-readable contract artifact. The API and owning App cell exchange this exact identity during startup compatibility negotiation and fail readiness on any mismatch. The same identity is included in the canonical deployment manifest.

V7 declares every request-dependent scope and dynamic policy used by collaboration, automation, custom-field content, calendar, work-management, and search/export handlers. The owning App cell resolves stored targets before evaluating grants, and its V13 runtime provides one exact resolver for every authenticated action. Promotion remains evidence-gated per cell; contract completeness alone does not activate principal enforcement.

The registry covers personal access credentials and native service accounts without converting existing credentials. Delegated OAuth remains separately feature-gated until its cell-local migration, consent, revocation, and policy-family qualification are complete.

Product capability ledger

Operation parity is not the same as total TeamGrid product coverage. The separate product ledger classifies 74 capabilities against the current implementation:

Status Count Meaning
Released in the stable contract 62 A bounded public v1 workflow is implemented across its required surfaces
Partial 0 No capability is advertised with an incomplete public workflow
Planned 6 The workflow remains on the roadmap and is not part of the current contract
Intentionally private 6 The capability is an implementation or privileged control plane, not a public API target

API version discovery, system capability discovery, workspace entitlements, safe workspace settings, the event catalog, project reads, complete project-template capture and instantiation, task reads, writes and lifecycle, complete planned-work scheduling, complete non-billing time-entry reads and writes, complete contact reads, complete audit reads and bounded audit exports, complete custom-field-value reads and compare-and-set writes, credential and service-account lifecycle, service-account resource grants, project sharing, conflict-safe task bulk operations, recurring tasks, time-entry billing, the qualified change feed, and webhook-secret rotation are released in the stable contract. Remaining planned work is limited to delegated OAuth, telephony, file sharing, orders, reports, and imports.

Raw database access, generic Meteor/DDP calls, superadmin controls, provider secrets, internal automation tasks, and the file-device synchronization protocol remain private. Customer workflows are represented by stable resources and domain commands instead of those internals.

Post-1.1 qualification boundary

The six planned domains are additive roadmap candidates, not hidden or partially supported endpoints:

  • Delegated OAuth needs complete consent, acting-user, token rotation, revocation, and cell-local policy lifecycles.
  • Telephony calls need provider-independent resources plus explicit side-effect, recording, privacy, and delegated-user semantics.
  • File sharing needs a public share-link lifecycle distinct from private transfer intents and the internal device-synchronization protocol.
  • Commerce orders need a customer-facing order resource rather than exposure of internal project-automation state.
  • Report jobs need immutable definitions, bounded execution, private result storage, and snapshot semantics.
  • Import jobs need schema-versioned validation, dry-run results, idempotent commit, per-row outcomes, and safe rollback boundaries.

Future 1.x releases may add qualified resources and commands without weakening stable 1.1 behavior. Existing operation semantics, scopes, errors, regional routing, and security boundaries remain compatible throughout the major version. A breaking change requires a new API major.

See the API v1 reference, CLI commands, and MCP tool policy for the current public surface.

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

Search TeamGrid Developer

Find guides, concepts and every API operation.