/tasks/{id}Read operationGet a task
Use this operation to get a task. It returns the resource only when it belongs to the authenticated workspace and is visible to the credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
tasks:readPrepare this request
The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.
Path parameters
1idrequiredStable identifier of the resource in the authenticated workspace.
Responses
7200The request to get a task succeeded. The response contains the canonical public result and request metadata.application/json
application/jsonPublic API representation of task.
The attributes associated with this task.
archivedrequiredWhether this resource is archived.
archivedAtrequiredTimestamp at which the resource was archived, or null when it is active.
assigneeIdrequiredIdentifier of the user assigned to this work item.
billablerequiredWhether this time or service can be billed.
completedrequiredWhether the work item is complete.
completedAtrequiredTimestamp at which the work item was completed.
completedByIdrequiredThe completed by id associated with this task attributes.
commentsCountrequiredNumber of comments records represented by this task attributes.
contactIdrequiredIdentifier of the related contact.
createdAtrequiredTimestamp at which the resource was created.
createdByIdrequiredThe created by id associated with this task attributes.
descriptionrequiredHuman-readable description of the resource.
descriptionFormatrequiredHow to interpret the task description. Legacy and unmarked descriptions are plain-text; markdown-v1 enables TeamGrid Markdown.
plain-textmarkdown-v1developerRevisionrequiredThe developer revision associated with this task attributes.
developerUpdatedAtrequiredISO 8601 timestamp for developer updated at.
duplicateOfTaskIdrequiredThe duplicate of task id associated with this task attributes.
dueAtrequiredISO 8601 timestamp for due at.
filesCountrequiredNumber of files records represented by this task attributes.
groupIdrequiredIdentifier of the related workspace group.
listIdrequiredIdentifier of the related task list.
listOrderrequiredThe list order associated with this task attributes.
namerequiredHuman-readable name of the resource.
orderrequiredThe order associated with this task attributes.
personalListIdrequiredThe personal list id associated with this task attributes.
personalListOrderrequiredThe personal list order associated with this task attributes.
plannedEndAtrequiredISO 8601 timestamp for planned end at.
plannedMinutesrequiredThe planned minutes associated with this task attributes.
plannedStartAtrequiredISO 8601 timestamp for planned start at.
projectIdrequiredIdentifier of the related project.
recurrencerequiredThe recurrence associated with this task attributes.
serviceIdrequiredIdentifier of the related service.
subscriberIdsrequiredOrdered set of subscriber identifiers associated with this task attributes.
subtasksCountrequiredNumber of subtasks records represented by this task attributes.
The subtasks associated with this task attributes.
completedrequiredWhether the work item is complete.
idrequiredStable TeamGrid identifier for this resource.
orderrequiredThe order associated with this task attributes subtasks.
titlerequiredHuman-readable title of the resource.
tagIdsrequiredOrdered set of tag identifiers associated with this task attributes.
trackingActiverequiredWhether tracking active applies to this task attributes.
updatedAtrequiredTimestamp of the most recent successful update.
idrequiredStable TeamGrid identifier for this resource.
typerequiredCanonical type discriminator for this resource.
Public API representation of meta.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
400The request is invalid.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
401The bearer credential is missing, invalid, expired, or revoked.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
403The credential has insufficient scope.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
404The tenant-scoped resource does not exist.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
429The credential or source exceeded its rate limit.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
503A required cell-local dependency is unavailable.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
Thank you. The rating contains no account or customer data.