Grouped Approvals

List grouped approvals by parent

Changed on

Returns the grouped approvals associated with a Workfront parent object (e.g. a project or task). Supply the parent's parentId, and optionally its objCode, as query parameters.

get/api/v1/grouped-approvals

Request

  • Base URL: https://workfront.adobe.io/workfront-approvals
  • URL: https://workfront.adobe.io/workfront-approvals/api/v1/grouped-approvals
  • Auth: HTTP bearer

Query parameters

parentIdstring required

Workfront parent object ID (e.g. 5f9a1c2b0000d4e1a1b2c3d4e5f60718).

objCodestring

Workfront parent object type code (e.g. PROJ, TASK).

Headers

x-api-keystring required

client_id of the Adobe Developer Console technical account. Identifies the calling integration to the AIO gateway.

x-gw-subdomainstring required

Workfront customer subdomain (e.g. mycompany). Must match the subdomain of the Workfront instance being accessed. Passing an incorrect or unrecognized subdomain will result in a 502 Bad Gateway response from the AIO gateway.

wf-customeridstring required

Workfront customer ID.

wf-useridstring required

Workfront user ID of the acting user.

wf-lane'prod' | 'preview' | 'hub' | 'staging' | 'devtest' required

Workfront deployment lane.

x-request-idstring uuid

Unique identifier for request tracing. Auto-generated if not provided.

x-correlation-idstring

Unique identifier for correlation across multiple service calls. Auto-generated if not provided.

Response

OK

messagestring

Present only when data is empty; states the parentId the lookup was scoped to.

Example response

{
  "data": [
    {
      "groupedApprovalGuid": "9f8b60820000462ecf66c409d1248fa9",
      "name": "Q1 Campaign Assets",
      "status": "in review"
    }
  ]
}

Changes