TeamGrid APIStable 1.2.0
API v1 reference
Stable, cell-aware TeamGrid API for scoped personal-access and service-account credentials, the TeamGrid CLI, and first-party developer clients.
Operations238
Resource groups34
SpecificationOpenAPI 3.1.0
System
2 operationsAuthentication
4 operationsWorkspace
4 operationsCalendar
13 operationsgetList appointments in a bounded interval
/appointments→postCreate a TeamGrid-managed appointment/appointments→getGet an appointment/appointments/{id}→patchUpdate a TeamGrid-managed appointment/appointments/{id}→deleteArchive a TeamGrid-managed appointment/appointments/{id}→postRestore a TeamGrid-managed appointment/appointments/{id}/restore→getList absences in a bounded interval/absences→postCreate an absence/absences→getGet an absence/absences/{id}→patchUpdate an absence/absences/{id}→deleteArchive an absence/absences/{id}→postRestore an absence/absences/{id}/restore→getList user availability/availability→Collaboration
7 operationsDocuments
6 operationsFiles
9 operationsgetList public-space file metadata
/files→getGet file metadata/files/{id}→patchRename a file/files/{id}→deleteArchive a file/files/{id}→postRestore a file/files/{id}/restore→postCreate a file download intent/files/{id}/download-intent→postReserve and create a private file upload intent/file-upload-intents→postFinalize a file upload intent/file-upload-intents/{id}/finalize→deleteCancel a file upload intent/file-upload-intents/{id}→Products
5 operationsProduct Groups
5 operationsProjects
11 operationsgetList projects
/projects→postCreate a project/projects→getGet a project/projects/{id}→patchUpdate a project/projects/{id}→getGet project sharing/projects/{id}/sharing→putReplace project sharing/projects/{id}/sharing→postComplete a project asynchronously/projects/{id}/complete→postReopen a project asynchronously/projects/{id}/reopen→postArchive a project asynchronously/projects/{id}/archive→postRestore a project asynchronously/projects/{id}/restore→getGet a project lifecycle operation/project-lifecycle-operations/{id}→Project Templates
8 operationsgetList project templates
/project-templates→postCapture a project as a template/project-templates→getGet project-template metadata/project-templates/{id}→patchUpdate project-template metadata/project-templates/{id}→deleteArchive a project template/project-templates/{id}→postRestore an archived project template/project-templates/{id}/restore→postInstantiate a project template asynchronously/project-templates/{id}/instantiate→getGet a project-template instantiation operation/project-template-instantiations/{id}→Planned Work
4 operationsProject Statements
6 operationsgetList project statements
/project-statements→postCreate a project statement/project-statements→getGet a project statement/project-statements/{id}→patchUpdate a project statement/project-statements/{id}→deleteArchive a project statement/project-statements/{id}→postRestore a project statement/project-statements/{id}/restore→Tasks
14 operationsgetList tasks
/tasks→postCreate a task/tasks→postUpdate multiple tasks safely/tasks/bulk-update→getGet a task/tasks/{id}→patchUpdate a task/tasks/{id}→deleteArchive a task/tasks/{id}→postRestore an archived task/tasks/{id}/restore→postDuplicate a task/tasks/{id}/duplicate→postMove or reorder a task/tasks/{id}/move→putReplace a task checklist/tasks/{id}/subtasks→postComplete a task/tasks/{id}/complete→postReopen a completed task/tasks/{id}/reopen→postStart task time tracking/tasks/{id}/timer/start→postStop task time tracking/tasks/{id}/timer/stop→Time Entries
8 operationsgetList time entries
/time-entries→postCreate a time entry/time-entries→getGet a time entry/time-entries/{id}→patchUpdate a time entry/time-entries/{id}→deleteArchive a time entry/time-entries/{id}→getGet time-entry billing state/time-entries/{id}/billing→putUpdate time-entry billing state/time-entries/{id}/billing→postRestore an archived time entry/time-entries/{id}/restore→Contacts
4 operationsCall Notes
5 operationsContact Groups
6 operationsUsers
1 operationTask Metadata
18 operationsgetList workspace lists
/lists→postCreate a list/lists→getGet a list/lists/{id}→patchUpdate a list/lists/{id}→deleteArchive a list/lists/{id}→postRestore an archived list/lists/{id}/restore→getList services/services→postCreate a service/services→getGet a service/services/{id}→patchUpdate a service/services/{id}→deleteArchive a service/services/{id}→postRestore an archived service/services/{id}/restore→getList tags/tags→postCreate a tag/tags→getGet a tag/tags/{id}→patchUpdate a tag/tags/{id}→deleteArchive a tag/tags/{id}→postRestore an archived tag/tags/{id}/restore→Custom Fields
6 operationsgetList custom-field definitions
/custom-field-definitions→postCreate a custom-field definition/custom-field-definitions→getGet a custom-field definition/custom-field-definitions/{id}→patchUpdate a custom-field definition/custom-field-definitions/{id}→deleteArchive a custom-field definition/custom-field-definitions/{id}→postRestore an archived custom-field definition/custom-field-definitions/{id}/restore→Custom Field Values
4 operationspostRead custom-field values for one resource
/custom-field-values/{targetType}/{resourceId}/batch-read→getGet a custom-field value/custom-field-values/{targetType}/{resourceId}/{fieldId}→putSet a custom-field value/custom-field-values/{targetType}/{resourceId}/{fieldId}→deleteClear a custom-field value/custom-field-values/{targetType}/{resourceId}/{fieldId}→Audit
1 operationWebhooks
7 operationsgetList webhooks
/webhooks→postCreate a webhook/webhooks→getGet a webhook/webhooks/{id}→patchUpdate or reactivate a webhook/webhooks/{id}→deleteRemove a webhook/webhooks/{id}→postRotate a credential-owned webhook signing secret/webhooks/{id}/secret-rotation→postSend a signed test webhook delivery/webhooks/{id}/test-delivery→Webhook Deliveries
2 operationsAdministration
19 operationsgetList workspace members
/members→getGet a workspace member/members/{id}→deleteRemove a workspace member/members/{id}→patchChange a member role/members/{id}/role→getList pending invitations/invitations→postInvite a workspace member/invitations→getGet a pending invitation/invitations/{id}→deleteCancel a pending invitation/invitations/{id}→postResend a pending invitation/invitations/{id}/resend→getList workspace roles/roles→postCreate a workspace role/roles→getGet a workspace role/roles/{id}→patchUpdate a workspace role/roles/{id}→deleteDelete a workspace role/roles/{id}→getList workspace groups/groups→postCreate a workspace group/groups→getGet a workspace group/groups/{id}→patchUpdate a workspace group/groups/{id}→deleteDelete a workspace group/groups/{id}→Search and Exports
5 operationsAutomations
11 operationsgetList public automation actions
/automation-actions→getList automation definitions/automation-definitions→postCreate an automation definition/automation-definitions→getGet an automation definition/automation-definitions/{id}→patchUpdate an automation definition/automation-definitions/{id}→deleteArchive an automation definition/automation-definitions/{id}→postRestore an automation definition/automation-definitions/{id}/restore→getList immutable automation definition versions/automation-definitions/{id}/versions→getList automation runs/automation-runs→getGet an automation run/automation-runs/{id}→postAbort a running automation/automation-runs/{id}/abort→Integrations
1 operationEvents
1 operationChanges
1 operationCredentials
7 operationsgetList personal access tokens owned by the current user
/me/personal-access-tokens→postCreate a personal access token/me/personal-access-tokens→deleteRevoke a personal access token/me/personal-access-tokens/{id}→postRotate a personal access token/me/personal-access-tokens/{id}/rotation→postCreate an independent service account credential/service-accounts/{id}/credentials→deleteRevoke a service account credential/service-accounts/{id}/credentials/{credentialId}→postRotate a service account credential/service-accounts/{id}/credentials/{credentialId}/rotation→Service Accounts
7 operationsgetList service accounts
/service-accounts→postCreate a service account and its initial credential/service-accounts→getGet a service account/service-accounts/{id}→patchEnable or disable a service account/service-accounts/{id}→deletePermanently revoke a service account/service-accounts/{id}→getGet the complete service account resource grant set/service-accounts/{id}/resource-grants→putReplace the complete service account resource grant set/service-accounts/{id}/resource-grants→Task Recurrences
26 operationsgetList task recurrences
/task-recurrences→postCreate a task recurrence/task-recurrences→postPreview a draft task recurrence/task-recurrences/preview→getGet a task recurrence/task-recurrences/{id}→patchUpdate a task recurrence/task-recurrences/{id}→deleteArchive a task recurrence/task-recurrences/{id}→getPreview a stored task recurrence/task-recurrences/{id}/preview→postRestore a task recurrence/task-recurrences/{id}/restore→postPause a task recurrence/task-recurrences/{id}/pause→postResume a task recurrence/task-recurrences/{id}/resume→postEnd a task recurrence/task-recurrences/{id}/end→postRemove a task recurrence from its tasks/task-recurrences/{id}/remove-from-tasks→postTransfer task recurrence ownership/task-recurrences/{id}/owner→postReplace a recurrence template from a task/task-recurrences/{id}/definition-from-task→getList task recurrence versions/task-recurrences/{id}/versions→getGet a task recurrence version/task-recurrences/{id}/versions/{versionId}→postRestore a task recurrence version/task-recurrences/{id}/versions/{versionId}/restore→getList task recurrence occurrences/task-recurrences/{id}/occurrences→getGet a task recurrence occurrence/task-recurrences/{id}/occurrences/{occurrenceKey}→putOverride a task recurrence occurrence/task-recurrences/{id}/occurrences/{occurrenceKey}/override→deleteClear a task recurrence occurrence override/task-recurrences/{id}/occurrences/{occurrenceKey}/override→postRetry a failed task recurrence occurrence/task-recurrences/{id}/occurrences/{occurrenceKey}/retry→postRecheck a task recurrence asynchronously/task-recurrences/{id}/recheck→postSubmit an event to a task recurrence/task-recurrences/{id}/events→getGet a task recurrence operation/task-recurrence-operations/{id}→postCancel a task recurrence operation/task-recurrence-operations/{id}/cancel→No operations match your search.