Approval Workflows

List approval workflows

GET/approval-workflows
approval-workflows:readlist_approval_workflowsRead-only

Lists the five workflow types an organisation can define approval steps for, ordered by type: client_invite, incoming_connect, internal_provider_publish, internal_publish and provider_approval. Each says whether the organisation has its own steps (custom) and, if so, shows the step tree. Changes nothing. Use GET /approval-workflows/{id} for one.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • fieldsstring#

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

  • sortstring#

    The only sort is id (the workflow type), ascending. Prefix it with - for descending.

Responses

200

The workflows.

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"
    }
  ],
  "meta": {
    "limit": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}
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
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\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"