Skip to navigation
Client SDKWorkflowsWorkflow Deployments

List Workflow Deployments

Beta

Used to list all Workflow Deployments.

Authentication

X-API-KEYstring
API Key authentication via header

Headers

X-API-VersionstringOptional

Query parameters

has_story_configstringOptional

has_story_config

is_publicstringOptional

is_public

limitintegerOptional
Number of results to return per page.
offsetintegerOptional
The initial index from which to return the results.
orderingstringOptional

Specifies the ordering of the returned Workflow Deployments. Valid values are:

  • created - Orders by creation time in ascending order.
  • -created - Orders by creation time in descending order. (default)
  • name - Orders by name in ascending order.
  • -name - Orders by name in descending order.

Compound orderings are supported by separating fields with commas, e.g., -created,name.

owned_bystringOptional

owned_by

statusenumOptional
status
Allowed values:

Response

This endpoint returns an object.
countintegerOptional
nextstring or nullOptionalformat: "uri"
previousstring or nullOptionalformat: "uri"
resultslist of objectsOptional