Skip to main content
GET
Browse the step library
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/listSteps[?category=<category>][&tag=<tag>] lists the step library, most recently changed first, optionally one category or one tag.

Authentication

External App credential or platform API key, or a Personal key. Requires permission workflows:read held at the platform scope; a key or app granted only at some org units receives 403. Each step carries its command, inputs, outputs, success criteria, category, tags, usage count and times, never its author. A page holds at most 500 steps; meta.partial is true when there were more, or when the library is too large for Forge to read whole (5,000 steps), so a step or a filter match may be missing. A failed read is an error, never an empty library. Each query parameter may appear once; an unknown parameter returns 400.

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

category
string
Minimum string length: 1
tag
string
Minimum string length: 1
limit
integer
default:50

Items per page, 1 to 100 (default 50); 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 <= 100
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.