Skip to main content
GET
List a workflow's asset bindings
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/listAssets?workflowId=<id>[&limit=<n>&cursor=<cursor>] returns the bindings [{key, fileId, filename, updatedAt}] in key order, a page at a time (limit 1–100, default 100). Keys sort by their stored character codes, so Z sorts before a.

Authentication

External App credential or platform API key, or a Personal key. Requires permission workflows:use at the workflow’s home, the launch permission; otherwise 403, recorded. 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 parameter workflowId (required, once). While meta.hasMore is true, pass meta.nextCursor as cursor (with the same workflowId) for the next page. A page may hold fewer bindings than limit while more remain; the list never answers meta.partial. Who bound a file is not returned.

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.

Path Parameters

workflowId
string
required

The workflow.

Minimum string length: 1

Query Parameters

limit
integer
default:100

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