v24

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2023-10-2712636.3 KB

flows

Find Flow by ID

Returns a single Flow by its ID, if the user is authorized to see it. This requires the 'flows.read' permission

get/flows/{id}

Path parameters

idstring string required

ID of flow to return

Response

Returns the flow

metaobject

Example response

{
  "data": {
    "name": "SnazzyToCodeComponent",
    "description": "This flow polls for persons and posts them on webhoo.site.",
    "graph": {
      "edges": [
        {
          "source": "step_1",
          "target": "step_2"
        }
      ]
    },
    "type": "ordinary",
    "cron": "* /2 * * * *",
    "status": "inactive",
    "createdAt": "2019-07-30T12:52:45.957Z",
    "updatedAt": "2019-07-30T12:52:45.957Z"
  }
}