Onboarding Flows

Get a form of an onboarding flow

GET/onboarding-flows/{onboarding_flow_id}/forms/{id}
onboarding:readget_onboarding_flow_formRead-only

Returns one form of the flow. The id is the form's own, as the list shows it. A form of another flow, or an unknown id, returns 404. Use GET /onboarding-flows/{onboarding_flow_id}/forms to list the forms. 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 form's id, a uuid, as the flow's form list shows it. A form of another flow returns 404.

Query parameters

  • fieldsstring#

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

Responses

200

The flow's form.

OnboardingFlowForm
{
  "data": {
    "id": "6d8f3a52-9a41-4d6c-b7a1-2c9e5d1b7f33",
    "name": "Source of wealth",
    "description": "Where your funds come from.",
    "is_start": false,
    "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}/forms/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"