Retrieve all flow templates - FlowMate API Documentation

This will only return Flow Templates 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 'flowTemplates.read' permissions.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

A list of flow templates.

Bodyapplication/json

Example

{
    "data": [
        {
            "name": "Example flow",
            "description": "This flow polls items from a source system and processes them with a code component.",
            "graph": {
                "nodes": [
                    [
                        {
                            "id": "step_1",
                            "componentId": "string",
                            "name": "Example adapter",
                            "function": "getItemsPolling",
                            "description": "Polls items from the source system"
                        },
                        {
                            "id": "step_2",
                            "componentId": "string",
                            "name": "Code component",
                            "function": "execute",
                            "description": "",
                            "fields": {
                                "code": "function* run() {console.log('Hello from the code component');yield msg;}"
                            }
                        }
                    ]
                ],
                "edges": [
                    {
                        "id": "string",
                        "config": {
                            "condition": "string",
                            "mapper": {}
                        },
                        "source": "step_1",
                        "target": "step_2"
                    }
                ]
            },
            "type": "ordinary",
            "cron": "*/5 * * * *",
            "owners": [
                {
                    "id": "string",
                    "type": "string"
                }
            ],
            "id": "string",
            "status": "published",
            "tags": [
                "advanced",
                "premium"
            ],
            "createdAt": "2019-07-30T12:52:45.957Z",
            "updatedAt": "2019-07-30T12:52:45.957Z"
        }
    ],
    "meta": {
        "page": 0,
        "perPage": 0,
        "total": 0,
        "totalPages": 0
    }
}