Flow Templates

List flow templates

GET/flow-templates
onboarding:readget_flow_templatesRead-only

Lists the platform's flow templates, ready-made onboarding journeys that are defined in code, not stored. It is a single list with no paging. Each template has its name, region, regulatory basis, page and field counts and the classifications it maps to. Use GET /flow-templates/{id} for its pages and routes, and POST /flow-templates/{id}/flows to copy one into a draft flow. It changes nothing.

Responses

200

Every flow template.

FlowTemplate[]
{
  "data": [
    {
      "id": "uk-investor-categorisation",
      "name": "UK Investor Categorisation (FCA COBS 4.7 / 4.12B)",
      "description": "FCA investor categorisation by direct factual qualification questions.",
      "region": "UK",
      "regulatory_basis": "FCA COBS 4.7 / 4.12B",
      "page_count": 7,
      "field_count": 24,
      "classifications": [
        {
          "name": "Certified High Net Worth",
          "description": "Income of at least 100,000 pounds or net assets of at least 250,000 pounds.",
          "mapping_summary": "Answered Yes to a High Net Worth test.",
          "conditions": null
        }
      ]
    }
  ]
}
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
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/flow-templates\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"