Skip to main content
GET
Find a workflow by name
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/getByName returns the workflow’s fields, as get names them.

Authentication

External App credential or platform API key, or a Personal key. Requires permission workflows:read at the workflow’s home: a workflow that is malformed, unknown, trashed, unhomed or outside the caller’s reach answers 404. A Personal key acts as its owner, narrowed by its scopes.

Behavior

Query parameters name (required) and factoryId (optional), each once. With factoryId, the workflow of that name in that factory; otherwise one without a factory is preferred, then any. A same-named workflow the caller cannot read is skipped, not reported; trashed workflows never match. No readable match answers 404. When more than 20 workflows share the name and none of those read is the caller’s, the lookup cannot finish and answers 409; send factoryId.

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

name
string
required

The workflow's name.

Minimum string length: 1
factoryId
string

The factory to look in.

Minimum string length: 1

Response

Success

data
object
required

A workflow's reviewed wire fields, without run aggregates.

meta
object
required