v2
latestOpenAPI 3.0.02026-07-31226285.0 KBFlows V2
listFlowTemplates
List all Flow Templates for a customer. Optionally, you can filter flow templates by trigger values.
get/v2/flows/templates
Query parameters
trigger_type'automation' | 'manual' | 'journey_submission'
Type of trigger for whom to filter flow templates
trigger_source_idstring
Id of the trigger source to filter flow templates. Interpretation depends on trigger_type:
- automation: use an {automation_flow_id} value
- journey_submission: use a {journey_id} value
- manual: this parameter is ignored; you can optionally filter by {trigger_schema}
trigger_schemastring
Schema of the trigger source to filter flow templates. This parameter only makes sense when trigger_type is manual
Response
Success - flow templates loaded with success. Empty array if customer has no flows defined.
Example response
{
"results": [
{
"created_at": "2021-04-27T12:01:13.000Z",
"updated_at": "2021-04-27T12:01:13.000Z",
"due_date": "2021-04-27T12:00:00.000Z",
"assigned_to": [
{
"variable": "{{entity.owner}}",
"value": [
"user_12345"
]
}
],
"phases": [
{
"due_date": "2021-04-27T12:00:00.000Z",
"assigned_to": [
{
"variable": "{{entity.owner}}",
"value": [
"user_12345"
]
}
]
}
],
"tasks": [
{
"due_date": "2021-04-27T12:00:00.000Z",
"assigned_to": [
{
"variable": "{{entity.owner}}",
"value": [
"user_12345"
]
}
]
}
],
"entity_sync": [
{
"trigger": {
"event": "FlowStarted"
},
"target": {
"entitySchema": "opportunity",
"entityAttribute": "title"
},
"value": {
"source": "workflow_name"
}
}
]
}
]
}