Retrieve all flows - FlowMate API Documentation

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.

Request

Query Params

page[size]

integer

optional

Amount of flows per page returned. Default is 10.

page[number]

integer

optional

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

filter[status]

string

optional

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

filter[type]

string

optional

Filter results by flow type (ordinary, long_running)

filter[user]

string

optional

Filter by user. Works for admin or users with same tenant.

sort

string

optional

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

string

optional

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.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

A list of flows.

Body

data

array[object (Flow) {11}]

optional

name

string

required

Example:

SnazzyToCodeComponent

description

string

optional

Example:

This flow polls for persons and posts them on webhoo.site.

tenant

string

optional

graph

object

FlowGraph

required

type

enum<string>

required

Flow type

Allowed values:

ordinaryrealtime

Example:

ordinary

cron

string

optional

A cron string describing the interval at which this flow is run. If unset, the flow uses webhooks instead

Example:

* /2 * * * *

owners

array[object (Owner) {2}]

optional

string

required

status

enum<string>

optional

Flow status, set automatically in response to start/stop commands

Allowed values:

activeinactivestartingstopping

Example:

inactive

createdAt

string <date-time>

required

Timestamp of flow creation

Example:

2019-07-30T12:52:45.957Z

updatedAt

string <date-time>

required

Timestamp of most recent flow update

Example:

2019-07-30T12:52:45.957Z

meta

object (Meta)

optional

page

integer

optional

Current page (1-based numbering)

perPage

integer

optional

Number of objects per page

total

integer

optional

Total number of objects

totalPages

integer

optional

Total number of pages

Example

{
    "data": [
        {
            "name": "SnazzyToCodeComponent",
            "description": "This flow polls for persons and posts them on webhoo.site.",
            "tenant": "string",
            "graph": {
                "nodes": [
                    [
                        {
                            "id": "step_1",
                            "componentId": "string",
                            "name": "snazzy adapter for oih",
                            "function": "getPersonsPolling",
                            "description": "New description in progress"
                        },
                        {
                            "id": "step_2",
                            "componentId": "string",
                            "name": "code_component",
                            "function": "execute",
                            "description": "",
                            "fields": {
                                "code": "function* run() {console.log('Calling external URL');yield request.post({uri: 'http://webhook.site/debc8244-3ca0-4449-af2b-e346c4f57b85', body: msg.body, json: true});}"
                            }
                        }
                    ]
                ],
                "edges": [
                    {
                        "id": "string",
                        "config": {
                            "condition": "string",
                            "mapper": {}
                        },
                        "source": "step_1",
                        "target": "step_2"
                    }
                ]
            },
            "type": "ordinary",
            "cron": "* /2 * * * *",
            "owners": [
                {
                    "id": "string",
                    "type": "string"
                }
            ],
            "id": "string",
            "status": "active",
            "createdAt": "2019-07-30T12:52:45.957Z",
            "updatedAt": "2019-07-30T12:52:45.957Z"
        }
    ],
    "meta": {
        "page": 0,
        "perPage": 0,
        "total": 0,
        "totalPages": 0
    }
}