Classification Requirements

List classification requirements of a workflow step

GET/workflow-steps/{workflow_step_id}/classification-requirements
transaction-workflows:readlist_workflow_step_classification_requirementsRead-only

Lists the classification requirements of one step, oldest first. A step with none returns an empty list; an unknown step returns 404. Use GET /workflow-steps/{workflow_step_id}/classification-requirements/{id} for one requirement.

Path parameters

  • workflow_step_idstring (uuid)Required#

    The workflow step the requirements belong to.

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.

Responses

200

The requirements.

ClassificationRequirement[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "workflow_step_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "classification_ids": [
        1
      ],
      "label": "string",
      "error_message": "string",
      "enabled": true,
      "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
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/workflow-steps/{workflow_step_id}/classification-requirements\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"