Onboarding Flows

Get a classification of an onboarding flow

GET/onboarding-flows/{onboarding_flow_id}/classifications/{id}

Returns one classification link of the flow. The id is the link's own, not the classification's. A link of another flow, or an unknown id, returns 404. Use GET /onboarding-flows/{onboarding_flow_id}/classifications to list them. It changes nothing.

Path parameters

  • onboarding_flow_idstring (uuid)Required#

    The onboarding flow's id, a uuid. An unknown or deleted id returns 404.

  • idstring (uuid)Required#

    The classification link's id, a uuid, as the flow's classification list shows it. A link of another flow returns 404.

Query parameters

  • fieldsstring#

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

Responses

200

The classification link.

OnboardingFlowClassification
{
  "data": {
    "id": "c3a5e0d1-7b24-4f19-8e66-1a9d2b4c6e77",
    "classification_id": 42,
    "created_at": "2026-11-08T10:30:00Z",
    "updated_at": "2026-11-08T10:30:00Z"
  }
}
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/onboarding-flows/{onboarding_flow_id}/classifications/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"