Grouped Approvals

Get grouped approval

Changed on

Returns a grouped approval by its GUID, including its paths, stages, participants, assets and rolled-up status.

get/api/v1/grouped-approvals/{groupGuid}

Request

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

Path parameters

groupGuidstring required
Example:9f8b60820000462ecf66c409d1248fa9

GUID of the grouped approval.

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

groupedApprovalGuidstring

The Grouped Approval GUID.

namestring

The name of the Grouped Approval.

templateIdstring nullable

The template the Grouped Approval was created from, if any.

status'not started' | 'pending review' | 'in review' | 'decided' | 'withdrawn'

The overall (rolled-up) status of the Grouped Approval.

Rolled-up lifecycle status:

  • not started - Not yet activated; no participant has started.
  • pending review - Active and awaiting decisions; participants have been notified but none has decided yet.
  • in review - Active with some decisions recorded, but not yet enough to conclude.
  • decided - All required decisions are in; a final decision has been reached.
  • withdrawn - Retracted; no further action is possible.
decisionDatestring date-time nullable

When the Grouped Approval reached a final decision.

assetReferenceTypesstring[]

Distinct reference types across all assets in the Grouped Approval.

createdByClientIdstring nullable

The client id that created the Grouped Approval.

lastModifiedByClientIdstring nullable

The client id that last modified the Grouped Approval.

createdAtstring date-time

Creation timestamp.

updatedAtstring date-time

Last update timestamp.

Example response

{
  "groupedApprovalGuid": "9f8b60820000462ecf66c409d1248fa9",
  "name": "Q1 Campaign Assets",
  "status": "in review",
  "decisionCounts": {
    "decided": 1,
    "undecided": 2
  },
  "creator": {
    "identityGuid": "884313730004e310f947559b08e68b11",
    "type": "USER",
    "references": [
      {
        "id": "884313730004e310f947559b08e68b11",
        "type": "wfUserId"
      },
      {
        "id": "15401B8A66C8F9CB0A49423C@13cc192466c8c9a949410f.e",
        "type": "imsUserId"
      },
      {
        "id": "creator@example.com",
        "type": "email"
      }
    ]
  },
  "assets": [
    {
      "assetGuid": "673fc29b0006af515e33732d1ebdc39a",
      "references": [
        {
          "id": "698b61d400011579a3dbc96cfb99ca06",
          "type": "DOCV"
        },
        {
          "id": "urn:aaid:sc:US:f9228e94-dace-34c9-91da-332a190186d4:0",
          "type": "esm"
        },
        {
          "id": "urn:aaid:aem:eb19fb9d-1543-47c1-b219-578f5be98d2c:1",
          "type": "genStudioDraft"
        }
      ],
      "decision": "approved"
    }
  ],
  "assetReferenceTypes": [
    "DOCV",
    "esm",
    "genStudioDraft"
  ],
  "paths": [
    {
      "pathId": "primary",
      "name": "Primary Review Path",
      "status": "in review",
      "decisionCounts": {
        "decided": 1,
        "undecided": 2
      },
      "stages": [
        {
          "stageId": "legal-review",
          "name": "Legal Review",
          "status": "in review",
          "decisionCounts": {
            "decided": 1,
            "undecided": 2
          },
          "participants": [
            {
              "identityGuid": "698b60820000462ecf66c409d1248fa9",
              "type": "USER",
              "references": [
                {
                  "id": "698b60820000462ecf66c409d1248fa9",
                  "type": "wfUserId"
                },
                {
                  "id": "1BF9194166C9284F0A49412F@13cc192466c8c9a949410f.e",
                  "type": "imsUserId"
                },
                {
                  "id": "approver@example.com",
                  "type": "email"
                }
              ],
              "role": "approver",
              "status": "opened",
              "decisionCounts": {
                "decided": 1,
                "undecided": 2
              }
            }
          ],
          "parentIds": [],
          "deadlineDate": "2025-01-16T12:00:00.000Z",
          "triggers": [
            {
              "type": "activation",
              "when": "onStagesComplete",
              "parameters": {
                "stages": [
                  "design-review"
                ],
                "allowedDecisions": [
                  "approved",
                  "approved with changes"
                ]
              }
            }
          ]
        }
      ]
    }
  ],
  "createdByClientId": "workfront-fusion",
  "lastModifiedByClientId": "workfront-fusion",
  "createdAt": "2025-01-10T09:00:00.000Z",
  "updatedAt": "2025-01-14T16:30:00.000Z"
}

Changes

  • 8b7d6eb43c60Revision changes
    • info

      removed the needs work enum value from the //////// response property for the response status

  • 68f7acba0ea1Revision changes
    • breaking

      the response property ////// became optional for the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • info

      added the optional property // to the response with the status