Skip to content
TeamGrid Developer
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Start here
Developer Hub
Choose an interface
Capability coverage
API v1
Overview
Quickstart
Credentials and scopes
Platform discovery and settings
Resources and semantics
Resource revisions and concurrent writes
Regional endpoints
Pagination and idempotency
Change feed
Custom fields
Project templates
Calendar and availability
Planned work
Collaboration and files
Workspace administration
Search and exports
Automations and integrations
Errors and rate limits
Signed webhooks
v1 endpoint reference
Overview
Calendar
Overview
List appointments in a bounded interval
GET
Create a TeamGrid-managed appointment
POST
Get an appointment
GET
Archive a TeamGrid-managed appointment
DELETE
Update a TeamGrid-managed appointment
PATCH
Restore a TeamGrid-managed appointment
POST
List absences in a bounded interval
GET
Create an absence
POST
Get an absence
GET
Archive an absence
DELETE
Update an absence
PATCH
Restore an absence
POST
List user availability
GET
Collaboration
Overview
List target activity
GET
List target comments
GET
Create a target comment
POST
Get a comment
GET
Archive a comment
DELETE
Restore a comment
POST
Documents
Overview
List document metadata
GET
Create a document
POST
Get a document
GET
Archive a document
DELETE
Update a document
PATCH
Restore a document
POST
Files
Overview
List public-space file metadata
GET
Get file metadata
GET
Archive a file
DELETE
Rename a file
PATCH
Restore a file
POST
Create a file download intent
POST
Reserve and create a private file upload intent
POST
Finalize a file upload intent
POST
Cancel a file upload intent
DELETE
System
Discover API v1
GET
Get credential-aware system capabilities
GET
Workspace
Get the authenticated workspace
GET
Get public workspace entitlements
GET
Get public workspace settings
GET
Update public workspace settings
PATCH
Projects
List projects
GET
Create a project
POST
Get a project
GET
Update a project
PATCH
Complete a project asynchronously
POST
Reopen a project asynchronously
POST
Archive a project asynchronously
POST
Restore a project asynchronously
POST
Get a project lifecycle operation
GET
Project Templates
Overview
List project templates
GET
Capture a project as a template
POST
Get project-template metadata
GET
Archive a project template
DELETE
Update project-template metadata
PATCH
Restore an archived project template
POST
Instantiate a project template asynchronously
POST
Get a project-template instantiation operation
GET
Products
Overview
List products
GET
Create a product
POST
Get a product
GET
Archive a product
DELETE
Update a product
PATCH
Product Groups
Overview
List product groups
GET
Create a product group
POST
Get a product group
GET
Archive a product group
DELETE
Update a product group
PATCH
Project Statements
Overview
List project statements
GET
Create a project statement
POST
Get a project statement
GET
Archive a project statement
DELETE
Update a project statement
PATCH
Restore a project statement
POST
Tasks
List tasks
GET
Create a task
POST
Get a task
GET
Archive a task
DELETE
Update a task
PATCH
Restore an archived task
POST
Complete a task
POST
Reopen a completed task
POST
Start task time tracking
POST
Stop task time tracking
POST
Time Entries
List time entries
GET
Create a time entry
POST
Get a time entry
GET
Archive a time entry
DELETE
Update a time entry
PATCH
Restore an archived time entry
POST
Contacts
List contacts
GET
Create a contact
POST
Get a contact
GET
Update a contact
PATCH
Call Notes
List call notes
GET
Create a call note
POST
Get a call note
GET
Archive a call note
DELETE
Restore an archived call note
POST
Contact Groups
List contact groups
GET
Create a contact group
POST
Get a contact group
GET
Archive a contact group
DELETE
Update a contact group
PATCH
Restore an archived contact group
POST
Users
List workspace users
GET
Task Metadata
List workspace lists
GET
Create a list
POST
Get a list
GET
Archive a list
DELETE
Update a list
PATCH
Restore an archived list
POST
List services
GET
Create a service
POST
Get a service
GET
Archive a service
DELETE
Update a service
PATCH
Restore an archived service
POST
List tags
GET
Create a tag
POST
Get a tag
GET
Archive a tag
DELETE
Update a tag
PATCH
Restore an archived tag
POST
Custom Fields
List custom-field definitions
GET
Create a custom-field definition
POST
Get a custom-field definition
GET
Archive a custom-field definition
DELETE
Update a custom-field definition
PATCH
Restore an archived custom-field definition
POST
Custom Field Values
Overview
Get a custom-field value
GET
Set a custom-field value
PUT
Clear a custom-field value
DELETE
Planned Work
Overview
List planned work in a bounded window
GET
Get a planned-work replacement operation
GET
Get a task planned-work schedule
GET
Replace task planned work asynchronously
PUT
Audit
List developer audit events
GET
Webhooks
List webhooks
GET
Create a webhook
POST
Get a webhook
GET
Remove a webhook
DELETE
Rotate a credential-owned webhook signing secret
POST
Webhook Deliveries
Overview
List webhook delivery history
GET
Get webhook delivery metadata
GET
Administration
Overview
List workspace members
GET
Get a workspace member
GET
Remove a workspace member
DELETE
Change a member role
PATCH
List pending invitations
GET
Invite a workspace member
POST
Get a pending invitation
GET
Cancel a pending invitation
DELETE
Resend a pending invitation
POST
List workspace roles
GET
Create a workspace role
POST
Get a workspace role
GET
Delete a workspace role
DELETE
Update a workspace role
PATCH
List workspace groups
GET
Create a workspace group
POST
Get a workspace group
GET
Delete a workspace group
DELETE
Update a workspace group
PATCH
Search and Exports
Overview
Search authorized TeamGrid resources
POST
Create an asynchronous export
POST
Get export job status
GET
Create an export download intent
POST
Download a completed export through TeamGrid
GET
Automations
Overview
List public automation actions
GET
List automation definitions
GET
Create an automation definition
POST
Get an automation definition
GET
Archive an automation definition
DELETE
Update an automation definition
PATCH
Restore an automation definition
POST
List immutable automation definition versions
GET
List automation runs
GET
Get an automation run
GET
Abort a running automation
POST
Integrations
Overview
List integration installation status
GET
Events
Overview
Get the scoped public event catalog
GET
API v0 · Legacy
Legacy API overview
Guides
Recipes
Migrate to v1
v0 endpoint reference
Overview
discovery
Legacy API discovery redirect
GET
calendar
GET /calendar/{token}.ics
GET
callnotes
Get all call notes
GET
Create call note
POST
Delete call note
DELETE
Get a call note
GET
Delete call note
DELETE
contactgroups
Get all contact groups
GET
Update contact group
PUT
Create contact group
POST
Delete contact group
DELETE
Get a contact group
GET
Update contact group
PUT
Delete contact group
DELETE
contacts
Get all contacts
GET
Update contact
PUT
Create contact
POST
Get a contact
GET
Update contact
PUT
journalEntries
Get all journal entries
GET
Update journal entry
PUT
Create journal entry
POST
Delete journal entry
DELETE
Get a journal entry
GET
Update journal entry
PUT
Delete journal entry
DELETE
lists
Get all lists
GET
Update list
PUT
Create list
POST
Delete list
DELETE
Get a list
GET
Update list
PUT
Delete list
DELETE
productgroups
Get all product groups
GET
Update product group
PUT
Create product group
POST
Delete product group
DELETE
Get a product group
GET
Update product group
PUT
Delete product group
DELETE
products
Get all products
GET
Update product
PUT
Create product
POST
Delete product
DELETE
Get a product
GET
Update product
PUT
Delete product
DELETE
projects
Get all projects
GET
Update project
PUT
Create project
POST
Get a project
GET
Update project
PUT
projectTemplates
Get all project templates
GET
Update project template
PUT
Create project template
POST
Delete project template
DELETE
Get a project template
GET
Update project template
PUT
Delete project template
DELETE
scheduledWork
Get all scheduled work
GET
services
Get all services
GET
Get a service
GET
tags
Get all tags
GET
Get a tag
GET
tasks
Get all tasks
GET
Update task
PUT
Create task
POST
Delete task
DELETE
Get a task
GET
Update task
PUT
Delete task
DELETE
Starts time tracking for a task
POST
Stops time tracking for a task
POST
teams
Get team
GET
times
Get all time entries
GET
Update time entry
PUT
Create time entry
POST
Delete time entry
DELETE
Get a time entry
GET
Update time entry
PUT
Delete time entry
DELETE
users
Get users
GET
webhooks
Get all webhooks
GET
Create a webhook
POST
Delete webhook
DELETE
Get webhook
GET
Delete webhook
DELETE
TypeScript SDK
SDK overview
Quickstart
Pagination and errors
Webhook verification
CLI
CLI overview
Install and authenticate
Commands
Automation
MCP server
MCP overview
Configure a host
Tools and security
Resources
Changelog
OpenAPI files
Security
GitHub
Select theme
Dark
Light
Auto
Overview
Integrations
Section titled “Integrations”
Secret-free installation status for supported workspace integrations.
Operations
Section titled “Operations”
GET
/integration-installations