Get a flow template
GET
/flow-templates/{id}Returns one flow template with its pages, their fields and its routes. The id is the template's key, such as uk-investor-categorisation, not a uuid. An unknown key returns 404. Use POST /flow-templates/{id}/flows to copy it into a flow. It changes nothing.
Path parameters
The template's key, such as
uk-investor-categorisation. It is text, not a uuid. An unknown key returns 404.
Responses
{
"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": 2,
"field_count": 2,
"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
}
],
"start_page_reference": "uk-risk-warning",
"pages": [
{
"reference": "uk-risk-warning",
"name": "Risk warning",
"description": null,
"is_start": true,
"is_no_access_terminal": false,
"section_type": null,
"fields": [
{
"reference": "uk-q-acknowledge",
"type": "CHECKBOX",
"label": "I have read the risk warning",
"description": null,
"options": null,
"required": true,
"display_conditions": null
}
]
},
{
"reference": "uk-qualification",
"name": "Qualification",
"description": null,
"is_start": false,
"is_no_access_terminal": false,
"section_type": null,
"fields": [
{
"reference": "uk-q-income",
"type": "DROPDOWN",
"label": "Is your annual income at least 100,000 pounds?",
"description": null,
"options": [
"Yes",
"No"
],
"required": true,
"display_conditions": null
}
]
}
],
"routes": [
{
"from_page_reference": "uk-risk-warning",
"to_page_reference": "uk-qualification",
"condition_summary": "Risk warning acknowledged.",
"condition": null,
"condition_group": null
},
{
"from_page_reference": "uk-qualification",
"to_page_reference": "uk-high-net-worth",
"condition_summary": "Answered Yes to at least one of the High Net Worth tests.",
"condition": null,
"condition_group": {
"condition_type": "NUMBER_MATCH",
"condition_value": "1",
"conditions": [
{
"field_reference": "uk-q-income",
"operator": "=",
"value": "Yes"
}
]
}
}
]
}
}403Error
Authorization failed. error.code is one of org_disabled,
ip_blocked, missing_scope, scope_disabled, user_disabled.
Examples
curl https://your-org-domain/kong/core/api/v2/flow-templates/{id}\
-H "Authorization: Bearer $HELM_API_KEY"\
-H "Content-Type: application/json"