GET /hub/v1/approvals-v2

Retrieves all approval items belonging to current user. Use the request parameters and supported operators to filter the results by various fields. For example, GET ../approvals?f[objecttype][eq]=CMSAsset1,JobUrl1&f[objectid][eq]=1 retrieves all approval items where Objecttype equals to CMSAsset or JobUrl AND where objectId equals 1. The response includes details of the approval and workflow items, with the current state and the transitions available for the current user’s roles. Use the GET /approvals-v2/{id} resource with available objectType and objectId values to retrieve a single approval item.

NameTypeDescription
f[workflowState]stringThe state will vary based on the workflow. Possible fields include: draft, submitted, reviewed, returned, approved, defining. This filter supports 'eq' and 'not' operators.
f[workflowType]stringType of workflow. This filter supports 'eq' and 'not' operators.
f[objectType]stringObject type. This filter supports 'eq' and 'not' operators.
f[cmsAssetType]stringAsset type. This filter supports 'eq' and 'not' operators.
f[objectId]stringId of the object. This filter supports 'gt', 'gte', 'lt', 'lte', 'eq', and 'not' operators.
f[deadline]stringDeadline for approval. This filter supports 'gt', 'gte', 'lt', 'lte', 'eq', and 'not' operators. For example, GET ../approvals?f[deadline][gte]='2015-12-08T12:00Z' retrieves all approval items where the deadline is greater than or equal to 2015-12-08, with a time offset of 12:00Z.
$pagesizestringNumber of records per page
$pagestringNumber of pages to retrieve
sortstringSort on one of the following fields: Name, CreatedDate, WorkflowState, Deadline (ASC) -Name, -CreatedDate, -WorkflowState, -Deadline (DESC).
StatusNameTypeDescription
200  Response includes a list of approval items.
 countstringNumber of records retrieved
 pagestringCurrent page number
 pageSizestringNumber of records on each page
 commentCountsobjectComment counts
 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
 itemsarrayList of approval items
 items.approvalItemIdstringId for approval item
 items.objectTypestringObject type for approval item
 items.objectIdstringUnique Id of the object associated with the approval item
 items.namestringName of the approval item
 items.descriptionstringDescription of the approval item
 items.workflowItemIdstringId of the workflow item
 items.workflowStatestringWorkflow state of the approval item
 items.workflowTypestringType of the workflow
 items.workflowNamestringName of the workflow
 items.deadlinearrayDeadline for the approval item
 items.commentCountsobjectComment counts
 items.commentCounts.openstringNumber of comments that are open
 items.commentCounts.addressedstringNumber of comments that are addressed
 items.commentCounts.completedstringNumber of comments that are completed
 items.commentCounts.totalstringTotal number of comments
 items.workflowItemobjectWorkflow item object
 items.workflowItem.workflowItemIdstringWorkflow item id
 items.workflowItem.workflowRoundstringWorkflow round
 items.workflowItem.typestringWorkflow type
 items.workflowItem.currentStateobjectCurrent state of the workflow
 items.workflowItem.currentState.stateIdstringId of the current state
 items.workflowItem.currentState.stateNamestringCurrent state name
 items.workflowItem.currentState.isEndStatestringIs the current state the final state?
 items.workflowItem.currentState.modifiedDatestringDate the workflow item is modified
 items.workflowItem.availableTransitionsarrayCollection of available workflow states
 items.workflowItem.availableTransitions.idstringId of the available workflow state
 items.workflowItem.availableTransitions.namestringName of the available workflow state
 items.workflowItem.availableTransitions.isPersistablestringDefines if the workflow item is persistable
 items.blockedstringDefines if emails will be sent out. If blocked = true, then emails will not be sent.
    
400_OrderByInvalid  The GET request parameter - $OrderBy is invalid and thus the request cannot be processed.
 messagestringThe GET request parameter - $OrderBy is invalid and thus the request cannot be processed.
 errorcodestringError code for the exception (10000)
    
400_OperatorNotSupported  The operator 'neq' is not supported.
 messagestringThe operator 'neq' is not supported.
 errorcodestringError code for the exception (10000)
    
400_FilterInvalid  The GET request filter parameter is invalid and thus the request cannot be processed.
 messagestringThe GET request filter parameter is invalid and thus the request cannot be processed
 errorcodestringError code for the exception (10000)