List templates

GET/api/templates

Lists the templates this workspace may use.

Needs an API token with the Read permission for workflows (workflow:read).

Parameters

Query

viewOptional · string: summary leaves out each row’s definition and createdBy. Any other value is refused.

Whose templates

In an organization, every template saved in any of its workspaces: scope: org.

In a partner’s customer account, only those saved in this workspace (workspace) and, while the license includes Embed, those the installation shares with its customers (installation), newest first. See Templates for customers.

What is left out or marked

A template with a step on an app this workspace may not use is left out. One on an app this installation doesn’t run is listed with available: false and unavailable, the reason. One that can’t be read is left out, or, with view=summary, shown with readable: false to someone who may delete it.

slots lists the connections a workflow made from it needs. toFill counts the values using it would ask for. uses, for its author and admins, counts the workflows made from it.

Responses

200OK
The templates; the installation’s shared ones first. None answers [].
400VALIDATION_ERROR
view isn’t summary.
403FORBIDDEN
The token lacks the Read permission for workflows.
500INTERNAL_ERROR
The list couldn’t be read. Try again.
503PIECES_UNAVAILABLE
GoRunner couldn’t check which apps this workspace may use. Try again.

Any call can also answer: 401 UNAUTHORIZED · 401 TOKEN_ENDED · 403 TOKEN_SURFACE_OFF · 403 FEATURE_OFF · 403 EMBED_NOT_ALLOWED · 403 EMBED_NOT_AVAILABLE · 403 ACCOUNT_SUSPENDED · 429 RATE_LIMITED · 503 BUSY · 503 PAUSED · 503 SERVICE_UNAVAILABLE. See Errors.

Request

GORUNNER="https://api.gorunner.io"
GORUNNER_TOKEN="grt_…"  # needs Read for workflows

curl "$GORUNNER/api/templates?view=summary" \
  -H "Authorization: Bearer $GORUNNER_TOKEN"

const GORUNNER = "https://api.gorunner.io";
const TOKEN = process.env.GORUNNER_TOKEN;

const res = await fetch(
  `${GORUNNER}/api/templates?view=summary`,
  {
    headers: { Authorization: `Bearer ${TOKEN}` },
  },
);
const { data } = await res.json();

import os, requests

GORUNNER = "https://api.gorunner.io"
TOKEN = os.environ["GORUNNER_TOKEN"]

res = requests.get(
    f"{GORUNNER}/api/templates",
    params={"view": "summary"},
    headers={"Authorization": f"Bearer {TOKEN}"},
)
data = res.json()["data"]

Response · 200 OK, shortened

json

{
  "data": [
    {
      "id": "9c4e2a17-3d5b-4f86-b0e2-8a1c7d3f5e29",
      "scope": "org",
      "name": "Order intake",
      "description": "Webhook to fulfilment, with a VIP branch.",
      "category": "Sales",
      "triggerType": "webhook",
      "createdAt": "2026-10-20T08:00:00Z",
      "author": {
        "name": "Ada Lovelace",
        "left": false
      },
      "savedHere": true,
      "trigger": {
        "displayName": "Order received",
        "pieceId": "webhook",
        "actionId": "catch_webhook"
      },
      "marks": [
        "webhook",
        "http"
      ],
      "slots": [],
      "toFill": 0,
      "available": true,
      "canManage": true
    }
  ]
}

Every field

It takes no body.

Response · 200 OK

dataarray of objects

idUUID

scopestring

Who sees it: org — an organization’s, every workspace of it; workspace — a customer account’s, the workspace it was saved in only; installation — shared by the installation with its customer accounts (listed only in a customer account, and only while the license has embedding), read-only here.

One of org, workspace, installation.

keystring

An installation template’s stable handle. Absent on every other template.

namestring

descriptionstring

What it does, as saved. May be empty: whenLine then describes it.

categorystring

Free-text grouping label; empty when none.

triggerTypestring

createdAttime

updatedAttime

publishedAttime

When an installation template was first offered. Absent on every other template.

readableboolean

false: its definition cannot be read. Such a row is listed only to someone who may delete it (canManage), with everything derived from the definition empty.

authorobject or null

Who saved it; null for an installation template.

idUUID or null

namestring or null

Their name, else their email; null once the account is deleted.

leftboolean

They are no longer a member of this organization.

sourceobject or null

An installation template’s origin; null otherwise.

organizationstring

The organization it was shared from; empty once that organization is gone.

savedHereboolean

It was saved in this workspace. Otherwise its bound values arrive blank (see TemplateFillField).

savedInstring or null

The workspace it was saved in (an installation template: the organization it was shared from); null when not recorded.

sourceWorkflowobject or null

The workflow it was saved (or last updated) from, while that workflow exists and is in this workspace.

idUUID

namestring

triggerobject or null

namestring

displayNamestring

pieceIdstring

actionIdstring

marksarray of strings

App ids in run order: the trigger’s, then one per step (branch steps branch, loops loop, a Code step code), never de-duplicated.

stepsarray of objects

Every step, in the order of marks after the trigger.

namestring

displayNamestring

pieceIdstring

actionIdstring

typestring

One of PIECE, CODE, BRANCH, LOOP.

depthinteger

0 at the top level; one more inside a branch arm, a loop body or an error path.

whenLinestring

A generated line for a template without a description: how it starts, then its first three steps’ names.

slotsarray of objects

The connections a workflow made from it needs, one per service account.

keystring

pieceIdstring

The connection’s app (what GET /api/connections rows carry).

pieceNamestring

stepsarray of strings

stepLabelsarray of strings

connectionIdstring or null

The connection the template’s own steps name; null for an installation template or none.

toFillinteger

How many values using it here will ask for: required fields left blank and bound values blanked here.

availableboolean

unavailableobject or null

Why it cannot be used on this installation.

codestring

One of PIECE_UNAVAILABLE, STEP_INCOMPLETE, ACTION_UNAVAILABLE, UNREADABLE.

messagestring

stepstring

The step it is about, by name.

usesobject or null

Workflows of this organization made from it, and how many are live. Sent only to its author, an organization admin or a platform admin.

workflowsinteger

liveinteger

canManageboolean

The caller may rename, update the steps of and delete it: its creator, an organization admin, or for a workspace template that workspace’s admin.

createdByUUID

Who saved it (author names them). Absent on an installation template, when the account is gone, and with view=summary.

definitionobject

A workflow definition — the same document the workflow API uses (schemaVersion is 2). It is a TREE, not a list: trigger is the root and each node chains onward through nextAction; branches[].firstAction and firstLoopAction hold nested sub-chains, and onErrorAction holds a step’s error arm. A step’s settings live in config, never settings. The trigger names its trigger in a field called actionId, and trigger type is lowercase while action type is UPPERCASE (PIECE, BRANCH, LOOP, CODE). A step that uses credentials carries connectionId — a bare connection id, workspace-scoped, which is why it may be cleared when the template is used in another workspace.

A workflow definition: its fields are in Workflow definition.

List templates

Parameters

Query

Whose templates

What is left out or marked

Responses

Response · 200 OK

Panel