API ReferenceWorkflows

List runs

Returns a page of workflow runs, newest first.

Sorting and date-range filtering are not supported. Use Get run for step output.

Authentication

Authorizationstring

Use the API key format: api-key <token>.

Query parameters

pageintegerOptional>=0Defaults to 0

Zero-based page index. Defaults to 0.

sizeintegerOptional1-100Defaults to 50
Page size between 1 and 100. Defaults to 50.
statusenumOptional

Filter by run status. CLOSED finds runs closed in Plextera Studio.

Allowed values:
workflowIdstringOptional
Return runs of one workflow only.

Response

One page of workflow runs.
datalist of objectsOptional
Items on the requested page.
pageInfoobjectOptional
Paging details for this result set.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
405
Method Not Allowed Error
406
Not Acceptable Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error