Skip to main content
GET
Retrieve persisted workflow step documents. Pass run_id when you want the complete set of steps for one run, or combine filters such as block_id, step_id, block_type, and status to inspect a narrower set. Returns the canonical { "data": [...], "list_metadata": { "before": null, "after": null } } pagination envelope shared with all Retab list endpoints. Cursor pagination is not yet implemented for this endpoint — list_metadata is always { before: null, after: null }. When run_id is omitted, the response is organization-scoped and bounded by limit with a default of 200 rows. Steps include an artifact ref when the block produced a persisted record. Use List Artifacts with step_id to dereference one ref, or with run_id to fetch all artifact records for the run.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

run_id
string | null

Optional workflow run ID filter.

workflow_id
string | null
block_id
string | null

Optional logical block ID filter.

step_id
string | null

Optional step ID filter.

block_type
string[] | null

Optional block type filter. Repeat the query parameter for multiple values.

status
string[] | null

Optional step lifecycle status filter. Repeat the query parameter for multiple values.

before
string | null

Step id cursor: return the page before this id (mutually exclusive with after).

after
string | null

Step id cursor: return the page after this id (mutually exclusive with before).

limit
integer
default:20

Maximum number of steps to return per page (1-1000). Each step hydrates its handle payloads from the artifact store, so raise it deliberately for larger pages and use cursor pagination for the rest.

Required range: 1 <= x <= 1000

Response

Successful Response

A page of WorkflowStep resources. data holds the items and list_metadata carries the before/after cursors; pass after to fetch the next page.

data
WorkflowStep · object[]
required
list_metadata
ListMetadata · object
required

Boundary resource IDs for page navigation.