Step Config Overrides

List step config overrides

GET/step-config-overrides
transaction-workflows:readlist_step_config_overridesRead-only

Lists a deal's step config overrides, newest first. Send filter[deal_id], or the call returns 422. An override replaces the configuration of one step requirement or trigger for this deal only.

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.

  • filter[deal_id]string (uuid)Required#

    Overrides on this deal. Required. Takes [in] and [not_in] with a comma-separated list.

  • filter[workflow_step_id]string (uuid)#

    Overrides of a requirement or trigger on this workflow step. Takes [in] and [not_in] with a comma-separated list.

  • filter[decorator_type]string#

    Only overrides of this kind: requirement or trigger. Takes [in] and [not_in] with a comma-separated list.

    One of: requirement, trigger
  • filter[created_at]string#

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

Responses

200

The overrides.

StepConfigOverride[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "deal_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "workflow_step_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "decorator_type": "requirement",
      "decorator_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "config": {},
      "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/step-config-overrides?filter[deal_id]={filter[deal_id]}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"