Transaction Workflows

List transaction workflows

GET/transaction-workflows
transaction-workflows:readlist_transaction_workflowsRead-only

Lists the reusable transaction workflows, newest first. Workflows are shared across the platform, so every token with the scope sees the same list. Filter by is_default or status to find the one new deals use. Add include=steps to embed each workflow's steps in order; use GET /workflow-steps to list steps across workflows.

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#

    Comma-separated fields to sort by, from the operation's allowed list. Prefix a field with - for descending. The record id is always the final tiebreak.

  • includestring#

    Comma-separated related records to embed, from the operation's allowed list.

  • filter[is_default]boolean#

    Only the default workflow (true) or only the others (false).

  • filter[status]string#

    Only workflows in this status: draft or published. Takes [in] and [not_in] with a comma-separated list.

    One of: draft, published
  • filter[q]string#

    Workflows whose name or label contains this text, ignoring case.

  • filter[created_at]string#

    Only workflows created in a range, written filter[created_at][gte]=2026-10-01. Takes gt, gte, lt and lte.

Responses

200

The workflows.

TransactionWorkflow[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "name": "string",
      "label": "string",
      "description": "string",
      "status": "draft",
      "is_default": true,
      "kyc_check_step_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "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/transaction-workflows\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"