Grouped Approvals

Search grouped approvals

Changed on

Searches grouped approvals using a named view. The default awaitingApprovals view returns groups where the requesting user (or one of the supplied teamIds) is a participant on the active stage and a decision is still required. Results are cursor-paginated: send limit for the first page, then the returned cursor for each subsequent page.

post/api/v1/grouped-approvals/search

Request

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

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.

Request body

view'awaitingApprovals'

Named view that determines the response shape. Currently only awaitingApprovals is supported.

teamIdsstring[]

Optional team IDs; the search also matches groups where one of these teams is a participant.

cursorstring nullable

Opaque cursor for the next page (from the prior response). When a non-null cursor is sent, limit is ignored.

limitinteger

Page size for the first page, when no cursor is supplied. Defaults to 20, max 100.

Response

OK

dataobject[] required

Result rows in the requested view's shape.

cursorstring nullable required

Cursor for the next page of results. Null if there are no more results.

Example response

{
  "data": [
    {
      "guid": "f47ac10b58cc4372a5670e02b2c3d479",
      "imsOrgId": "1269195F66C8C84F0A494025@AdobeOrg",
      "customerId": "697be14f00392452aa729f7eb29059fe",
      "name": "Grouped Approval 123",
      "creator": {
        "guid": "884313730004e310f947559b08e68b11",
        "type": "USER",
        "references": [
          {
            "id": "884313730004e310f947559b08e68b11",
            "type": "wfUserId"
          },
          {
            "id": "00000000000000000000000000000000@00000000000000000000.e",
            "type": "imsUserId"
          }
        ]
      },
      "createdAt": "2025-01-10T09:00:00.000Z",
      "stages": [
        {
          "name": "Legal Review",
          "stageId": "019dd8a16cb17a58a3b73fc991f16e07",
          "deadlineDate": "2025-01-16T12:00:00.000Z",
          "participant": {
            "guid": "698b60820000462ecf66c409d1248fa9",
            "type": "USER",
            "references": [
              {
                "id": "698b60820000462ecf66c409d1248fa9",
                "type": "wfUserId"
              }
            ],
            "role": "approver",
            "status": "opened",
            "decisionCounts": {
              "decided": 1,
              "undecided": 2
            }
          },
          "metadata": {
            "reviewLink": "https://frame.io/f47ac10b58cc4372a5670e02b2c3d479/stage/019dd8a16cb17a58a3b73fc991f16e07",
            "reviewLinkStatus": "success"
          }
        }
      ]
    }
  ],
  "cursor": null
}

Changes