Skip to main content
GET
List workflow templates
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/workflows/listTemplates[?limit=<n>&cursor=<cursor>] returns the templates, oldest first, a page at a time (limit 1–50, default 20), each with its nodes, edges and default inputs and outputs.

Authentication

External App credential or platform API key, or a Personal key. Requires permission workflows:read at the platform scope, as the Console decides it; otherwise 403, recorded. A Personal key acts as its owner, narrowed by its scopes.

Behavior

While meta.hasMore is true, pass meta.nextCursor as cursor for the next page. A page may hold fewer templates than limit while more remain; the list never answers meta.partial. Who wrote a template is not returned. Instantiate one with createFromTemplate.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

limit
integer
default:20

Items per page, 1 to 50 (default 20); a larger value is a 400 too_big. A page may hold fewer items than limit while meta.hasMore is true; continue with meta.nextCursor.

Required range: 1 <= x <= 50
cursor
string

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

Success

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.