v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Approval workflows

List approval workflows

Retrieve approval workflows with optional filtering.

get/v1/approvals/workflows

Query parameters

takenumber nullable
skipnumber nullable
boolean
OR
'true' | 'false'

Only return workflows matching this active state.

Response

Example response

{
  "meta": {
    "total": 1,
    "taken": 1
  },
  "data": [
    {
      "id": "apw_DKL4Xcb5VSa8CQ",
      "name": "Enterprise quote approval",
      "description": "Requires approval for high-value subscription quotes.",
      "applicable_flows": [
        "quote_subscription"
      ],
      "is_active": true,
      "priority": 10,
      "rules": [
        {
          "id": "apr_DKL4Xcb5VSa8CQ",
          "operator": "and",
          "conditions": [
            {
              "field": "total_amount",
              "operator": "gte",
              "value": {
                "period": "months",
                "count": 12
              }
            }
          ]
        }
      ],
      "step_execution": "sequential",
      "email_notification_enabled": true,
      "steps": [
        {
          "id": "aps_DKL4Xcb5VSa8CQ",
          "name": "Finance approval",
          "order": 1,
          "approver_requirement": "any",
          "approver_role_ids": [
            "rol_DKL4Xcb5VSa8CQ"
          ],
          "approver_user_ids": [
            "usr_DKL4Xcb5VSa8CQ"
          ]
        }
      ],
      "version": 1,
      "created_at": "2024-12-20T16:04:11Z"
    }
  ]
}