GET /hub/v1/approvals-v2/{id}

Retrieves an approval item that belongs to the current user. The response includes details of the approval and workflow item, with the current state and the transitions available for the current user’s roles. To retrieve all active approval items, perform a GET request on the /approvals resource.

NameTypeDescription
idstringRequired. The unique ID of the approval.
StatusNameTypeDescription
200  Response includes details about the approval item.
 approvalItemIdstringThe ID of the approval item
 objectTypestringThe object type for the approval item
 objectIdstringThe unique ID of the object associated with the approval item
 namestringName of approval item
 descriptionstringDescription of the approval item
 workflowItemIdstringThe ID of the workflow item
 workflowStatestringWorkflow state of the approval item
 workflowTypestringType of workflow
 workflowNamestringName of the workflow
 deadlinearrayDeadline for the approval item
 commentCountsobjectThe number of comments in the approval item
 commentCounts.openstringNumber of comments that are open
 commentCounts.addressedstringNumber of comments that are addressed
 commentCounts.completedstringNumber of comments that are completed
 commentCounts.totalstringTotal number of comments
 workflowItemobjectWorkflow item object
 workflowItem.workflowItemIdstringWorkflow item ID
 workflowItem.workflowRoundstringWorkflow round
 workflowItem.typestringWorkflow type
 workflowItem.currentStateobjectCurrent state of the workflow
 workflowItem.currentState.stateIdstringID of the current state
 workflowItem.currentState.stateNamestringCurrent state name
 workflowItem.currentState.isEndStatestringSpecifies whether the workflow item is in the final state
 workflowItem.currentState.modifiedDatestringThe date the workflow item is modified
 workflowItem.availableTransitionsarrayCollection of available workflow states
 workflowItem.availableTransitions.idstringID of the available workflow state
 workflowItem.availableTransitions.namestringName of the available workflow state
 workflowItem.availableTransitions.isPersistablestringDefines if the workflow item is persistable
 blockedstringDefines if emails will be sent out. If blocked = true, then emails won’t be sent.
    
400  id is a required field
 messagestringid is a required field.
 errorcodestringError code for the exception (10002)
    
404  No active approval with the given id exists.
 messagestringNo active approval with the given ID exists.
 errorcodestringError code for the exception (30003)