Onboarding Flows

List onboarding flows

GET/onboarding-flows
onboarding:readlist_onboarding_flowsRead-only

Lists onboarding flows, oldest first, and returns one page. A flow is the journey a respondent follows to join the platform: its forms, the routes between them and the classifications it earns. Flows belong to the whole tenant, so every token sees the same list, drafts included, and each flow carries its routes. Filter by filter[status], filter[user_type], filter[q] (name) and a filter[created_at] range. Use GET /onboarding-flows/{id} for one flow. It changes nothing.

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

  • filter[q]string#

    Flows whose name contains this text, ignoring case.

  • filter[status]string#

    Only flows with this status: draft or published. Takes [in] and [not_in] with a comma-separated list.

    One of: draft, published
  • filter[user_type]string#

    Only flows that can onboard this user type: investor or advisor. Without it, flows of every user type are listed. Takes [in] and [not_in].

    One of: investor, advisor
  • filter[created_at]string#

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

Responses

200

One page of onboarding flows.

OnboardingFlow[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "name": "string",
      "status": "draft",
      "expiry_type": "daily",
      "mode_type": "continuous",
      "user_types": [
        "investor"
      ],
      "routes": [
        {}
      ],
      "definition": {},
      "form_count": 1,
      "start_form_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "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/onboarding-flows\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"