OpenAPI files · TeamGrid Developer

Download the exact TeamGrid API v0 and v1 OpenAPI 3.1 contracts used to generate this documentation.

The API reference is generated from checked-in OpenAPI 3.1 contracts. The same files are available for code generation, validation, or import into an API client:

Contract policy

API v1 is the source contract for new integrations. The v0 file describes the frozen compatibility runtime rather than every operation historically advertised by the previous documentation.

The canonical manifest publishes byte counts and SHA-256 digests for both OpenAPI files, the v0 runtime inventory, and the cross-interface capability ledger. The documentation repository also records the immutable contract source commit and the API runtime commit carrying those artifacts in sources/contracts.json. CI fails if any published artifact or provenance field drifts.

The stable 1.1.0 manifest records 154 v1 paths, 237 governed v1 operations, 87 frozen v0 operations, 87 v0 migration decisions, 90 canonical scopes, and 74 classified TeamGrid product capabilities. It also records 18 resource-cas-v1 mutations, two qualified asynchronous-operation reads, and another 47 domain-specific If-Match operations. These counts describe the synchronized contract; they do not promote planned capabilities into the stable release.

Consumers should pin the manifest’s contractVersion together with the OpenAPI digest and package release they tested. The 1.1.0 checkpoint qualifies core project, task, and project-template CAS while preserving all domain-specific preconditions. Its synchronized SDK, CLI, and MCP package checkpoint is 1.1.0. See resource concurrency.

Use the versioned regional server URL from the credential location. Do not rewrite API v1 operations to a global API v0 host.

API clients

Postman can import the generated collection directly. Bruno, Insomnia and other clients that support OpenAPI should import /openapi/v1.json; this preserves the complete schema instead of depending on a client-specific export. Editors with an HTTP client can use the generated .http file.

Both generated downloads contain placeholders rather than credentials. Set baseUrl to the regional endpoint indicated by the credential and keep token in the client’s secret or environment store.