API v1 is the stable, recommended contract for new TeamGrid integrations. It uses regional ingress, scoped reveal-once credentials, cursor pagination, idempotent creates, consistent errors, strong write preconditions, and signed webhook deliveries. Version 1.1.0 contains 154 paths and 237 operations. This is interface coverage, not a claim that every TeamGrid product capability is public.
Base URL
The credential identifies its home region. Official clients derive the corresponding regional endpoint automatically:
https://api.<region>.teamgrid.app/v1German credentials use:
https://api.de.teamgrid.app/v1Do not send a bearer credential through a cross-region redirect. The target cell authenticates the full credential and rejects a region or cell mismatch.
Available resources
API v1 currently provides capability discovery, workspace entitlements and safe workspace settings; workspace and administration resources; projects, tasks, recurring tasks, time entries, planned work, appointments, absences, and availability; contacts, comments, activity, documents, files, call notes, and contact groups; product and project-statement resources; federated search and bounded export jobs; automation definitions, action metadata, runs, and integration-installation status; plus audit, an authorization-filtered webhook event catalog, webhook, secret-rotation, and credential-owned asynchronous-operation resources.
Most mutable resources use explicit domain operations instead of a generic database mutation endpoint. Project completion, reopen, archive, and restore are asynchronous lifecycle operations with a separately readable operation resource. Task and time-entry transitions remain synchronous domain commands. Product acquisition cost and project-statement finance data require additional finance scopes. Webhook delivery history is readable only for deliveries owned by the authenticated service credential.
Projects, project sharing, tasks, and project templates expose developer revisions and require strong
If-Match preconditions for their 18 mutating operations. Another 47 protected operations retain
domain-specific revision formats. Review resource concurrency
before building a writer.
For durable mirrors, create an initial resource snapshot and continue from the matching change-feed checkpoint. Signed webhooks remain useful delivery signals but are not a replayable history.
Review resource and security semantics before implementing finance, lifecycle, custom-field, administration, export, automation, or webhook-observability workflows.
Next steps
- Create and protect a scoped credential.
- Run the quickstart.
- Negotiate capabilities, entitlements, events, and safe settings.
- Choose the SDK or CLI if it fits your runtime.
- Review resources and semantics, resource concurrency, and pagination and idempotency before implementing synchronization or writes.