v24

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

Retrieve all flows associated with the current user from the repository

This will only return Flows that are either directly associated with the user, or that are associated with a tenant that the user is also a member of. Requires the 'flows.read' permissions.

get/flows

Query parameters

page[size]integer

Amount of flows per page returned. Default is 10.

page[number]integer

Number of the page to be returned. Default is 1.

filter[status]string

Filter results by flow status. Accepts either string ('active' and 'inactive') or integer (1 or 0)

filter[type]string

Filter results by flow type (ordinary, long_running)

filter[user]string

Filter by user. Works for users within the same tenant.

sortstring

Sort the result by one property. Supported: createdAt, updatedAt and name. Prefix field name with - for reversed sort order (DESC) i.e. sort=-updatedAt. Default sorting is by id ASC

searchstring

Search flows by a word or a phrase contained in the flow description OR in the flow name (case-insensitive). Behavior is similar to operator LIKE in SQL but case insensitive.

Response

A list of flows.

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"
    }
  ]
}
All 12 operations