Sign in
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.

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]integer

Filter results by flow status. Active = 1. Inactive = 0

filter[type]string

Filter results by flow type (ordinary, long_running)

filter[user]string

Filter by user. Works for admin or users with 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": "My Flow",
      "description": "My Flow"
    }
  ]
}

Changes