OPopenintegrationhub
templates

Retrieve all flow templates associated with the current user from the repository

Changed on

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.

get/templates

Request

Query parameters

page[size]integer

Number of flow templates 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. Published = 1. Draft = 0

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 template description OR in the template name (case-insensitive). Behavior is similar to operator LIKE in SQL but case insensitive.

Response

A list of flow templates.

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": "draft",
      "createdAt": "2019-07-30T12:52:45.957Z",
      "updatedAt": "2019-07-30T12:52:45.957Z"
    }
  ]
}

Changes