Onboarding Flows

List the forms of an onboarding flow

GET/onboarding-flows/{onboarding_flow_id}/forms
onboarding:readlist_onboarding_flow_formsRead-only

Lists the forms of a flow, oldest first, and returns one page. The first is the start form (is_start). These are the hidden forms the flow's pages are made of, so GET /forms does not show them. An unknown flow returns 404. Use GET /onboarding-flows/{onboarding_flow_id}/forms/{id} for one form. It changes nothing.

Path parameters

  • onboarding_flow_idstring (uuid)Required#

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

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: created_at. Prefix a field with - for descending. Defaults to created_at, oldest first. The record id is always the final tiebreak.

Responses

200

One page of the flow's forms.

OnboardingFlowForm[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "name": "string",
      "description": "string",
      "is_start": 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/onboarding-flows/{onboarding_flow_id}/forms\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"