Approval Workflows

Get an approval workflow

GET/approval-workflows/{id}
approval-workflows:readget_approval_workflowRead-only

Returns the approval workflow of one type for the organisation: whether it is custom and, if so, its step tree with each step's voters. A type the organisation has not defined returns custom: false and no steps. An unknown type, or user_invite, returns 404. Changes nothing. Use GET /approval-workflows to list them.

Path parameters

  • idstringRequired#

    The workflow type, such as internal_publish. Workflows are keyed by their type, not a UUID. The types are client_invite, incoming_connect, internal_provider_publish, internal_publish and provider_approval; any other value is 404.

    One of: client_invite, incoming_connect, internal_provider_publish, internal_publish, provider_approval

Query parameters

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

Responses

200

The workflow.

ApprovalWorkflow
{
  "data": {
    "id": "string",
    "request_kind": "opportunity",
    "custom": true,
    "steps": [
      {}
    ],
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/approval-workflows/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"