PApandadoc
Approval Workflows

[Beta] Get Submit for approval configuration

Changed on

Retrieves the Submit for approval configuration on a template. Learn more about approval workflows.

get/public/beta/templates/{template_id}/approval-workflow

Request

Response

Successfully retrieved the Submit for approval configuration.

is_enabledboolean required

Stored enabled flag. A configuration that is enabled but contains only groups with no approvers is still returned as enabled. An unconfigured template returns false.

is_ordering_enabledboolean required

Approval order. When true, the document goes to one approver at a time. When false, every approver is requested together. On an unconfigured template this is false (empty state). Creating a configuration with the field omitted defaults to true.

is_editing_allowedboolean required

Whether the approvers and approval groups can be edited on documents created from this template.

has_conditional_approvalsboolean required

true when an approver or an approval group has conditional approvals. Those conditional approvals are not included in steps. PUT on this path is rejected until they are removed in PandaDoc.

Example response

{
  "steps": [
    {
      "id": "fq9CX7PWgpe7eao6ujEdYG",
      "assignee": {
        "id": "mGVeQe7xy9AN9eCg8VSdNm",
        "user": {
          "id": "FA5QAu8UGA3oVDQZuPL75B",
          "email": "manager@example.com",
          "first_name": "Alex",
          "last_name": "Manager",
          "avatar": "https://avatars.pandadoc-static.com/users/FA5QAu8UGA3oVDQZuPL75B/avatar.jpeg"
        },
        "is_selected": true
      },
      "group": {
        "id": "XUF5pcWnMqYAfDX7mAD9kD",
        "name": "Finance",
        "type": "selectable",
        "assignees": [
          {
            "id": "mGVeQe7xy9AN9eCg8VSdNm",
            "user": {
              "id": "FA5QAu8UGA3oVDQZuPL75B",
              "email": "manager@example.com",
              "first_name": "Alex",
              "last_name": "Manager",
              "avatar": "https://avatars.pandadoc-static.com/users/FA5QAu8UGA3oVDQZuPL75B/avatar.jpeg"
            },
            "is_selected": true
          }
        ]
      }
    }
  ]
}

Changes