v2

latestOpenAPI 3.0.02026-07-31226285.0 KB

Flows V2

searchFlowTemplates

Search for flow templates by name, trigger type, enabled status, and more.

post/v2/flows/templates:search

Request body

namestring

definition_idstring

trigger_type'journey_submission' | 'manual' | 'automation'

enabledboolean

frominteger

sizeinteger

sort_by'created_at' | 'updated_at'

sort_order'asc' | 'desc'

Response

Success - flow templates loaded with success. Empty array if customer has no flows defined.

hitsnumber

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"
          }
        }
      ]
    }
  ]
}