v1Resources/Approvals/getGet a task
Get a task
Returns one task or subtask from Tasks & Approvals by its id: status, owner, approval state, dates and rowVersion. A task that doesn't exist, or that belongs to a client outside the key's access, returns 404. If Tasks & Approvals isn't turned on for your workspace, this returns 404.
get
approvals:read/api/v1/work-management/tasks/{id}Query parameters
idstringrequired
The task's id, a UUID. Any other value returns 404.
Response
okbooleanoptional
Always true on a successful response.
deliveryAvailablebooleanoptional
Whether this workspace can deliver approved content. May be missing.
itemobjectoptional
The task.
keystringoptional
The task's key, in the form task:<id>.
itemIdstringoptional
The task's id.
kindstring (task | subtask)optional
task for a top-level task, subtask for a subtask.
titlestringoptional
The task's title.
descriptionstringoptional
The task's description, or null.
statusstring (open | in_progress | awaiting_decision | approval_required | revision_requested | approved | rejected | done | dismissed)optional
Where the task stands. approval_required means it is waiting for its approver.
clientIdstringoptional
The client the task is for, or null for agency work.
locationIdstringoptional
The location the task is about, or null.
projectIdstringoptional
The project the task belongs to, or null.
projectNamestringoptional
The project's name, or null.
parentKeystringoptional
For a subtask, the parent task's key. Otherwise null.
ownersarray of objectoptional
The task's owner, as a list. New tasks have at most one; older tasks can still show several.
idstringoptional
The person's id. Pass it as ownerId when you create a task, or as userId when you set an owner.
namestringoptional
The person's display name.
typestring (user | client_user)optional
user for an agency teammate, client_user for a person from a client. Send the same value as ownerType.
avatarUrlstringoptional
The person's profile picture URL, if there is one.
creatorobjectoptional
Who created the task: a teammate or a client user. null when unknown.
idstringoptional
namestringoptional
typestring (user | client_user)optional
manualApprovalobjectoptional
The task's approver and the state of its approval request.
approverobjectoptional
The approver's id, name and type, or null when there is none.
statestring (approval_required | approved)optional
approval_required while a request waits for the approver, approved once approved, otherwise null.
requestIdstringoptional
The id of the pending approval request, or null.
feedbackstringoptional
The approver's reason when they asked for changes, while the task is open again. Otherwise null.
detailsobjectoptional
Labels, start date, time estimate and attached files.
labelsarray of stringoptional
startDatestringoptional
estimatedMinutesintegeroptional
attachmentsarray of objectoptional
keystringoptional
namestringoptional
mimestringoptional
sizeintegeroptional
prioritystring (urgent | high | medium | low)optional
The task's priority, or null.
dueAtstringoptional
When the task is due, in UTC, or null.
createdAtstringoptional
When the task was created, in UTC.
updatedAtstringoptional
When the task last changed, in UTC.
completedAtstringoptional
When the task was finished, in UTC, or null.
blockedByarray of stringoptional
Keys of open items that must be finished before this task.
openSubtaskCountintegeroptional
How many of its subtasks are still open.
commentCountintegeroptional
How many comments the task has.
rowVersionintegeroptional
The task's version number. It goes up each time the task is edited.
Errors
401Missing, invalid, expired, or revoked API key.
403Tasks & Approvals errors come back as ok: false with an error object holding code, message, retryable and details. Errors from the API key check itself (a missing or invalid key, a missing scope, the rate limit) use the standard error shape, where error is a string.
404Tasks & Approvals errors come back as ok: false with an error object holding code, message, retryable and details. Errors from the API key check itself (a missing or invalid key, a missing scope, the rate limit) use the standard error shape, where error is a string.
429Too many requests. Retry after the number of seconds in the Retry-After header.
500The request couldn't be completed because of a problem on our side.
get/api/v1/work-management/tasks/{id}
Your API key
id *
{}