Templates

Returns all approval templates visible to the current user.

get/api/v1/templates

Request

  • Base URL: https://workfront.adobe.io/workfront-approvals
  • URL: https://workfront.adobe.io/workfront-approvals/api/v1/templates
  • 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.

Response

OK

Example response

{
  "templates": [
    {
      "templateId": "template-id",
      "name": "Test Template",
      "assetType": "DOCV",
      "creatorId": "user-id",
      "customerId": "customer-id",
      "stages": [
        {
          "stageId": "stage-1",
          "name": "Stage 1",
          "deadlineBusinessDays": 3,
          "deadlineTimeOfDay": {
            "hours": 17,
            "minutes": 0
          },
          "participants": [
            {
              "participantId": "user-123",
              "participantType": "USER",
              "participantRole": "approver",
              "participantMetadata": {}
            }
          ]
        },
        {
          "stageId": "stage-2",
          "name": "Stage 2",
          "deadlineBusinessDays": 2,
          "deadlineTimeOfDay": {
            "hours": 12,
            "minutes": 30
          },
          "participants": []
        }
      ],
      "structure": [
        {
          "stageId": "stage-1",
          "parentIds": [],
          "triggers": [
            {
              "type": "activation",
              "when": "onCreate"
            }
          ]
        },
        {
          "stageId": "stage-2",
          "parentIds": [
            "stage-1"
          ],
          "triggers": [
            {
              "type": "activation",
              "when": "onStagesComplete",
              "parameters": {
                "stages": [
                  "stage-1"
                ],
                "allowedDecisions": [
                  "approved"
                ]
              }
            }
          ]
        }
      ],
      "paths": [],
      "usageCount": 0,
      "createdAt": "2026-01-15T17:00:00.000Z",
      "updatedAt": "2026-01-15T17:00:00.000Z"
    }
  ]
}

Changes

    • info

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

    • info

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

    • breaking

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

    • 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