Retrieve Workflow Deployment

Used to retrieve a workflow deployment given its ID or name.

Path parameters

idstringRequired

Either the Workflow Deployment’s ID or its unique name

Headers

X_API_KEYstringRequired

Response

idstringformat: "uuid"
namestring<=150 characters

A name that uniquely identifies this workflow deployment within its workspace

labelstring<=150 characters

A human-readable label for the workflow deployment

createddatetime
last_deployed_ondatetime
last_deployed_history_item_idstringformat: "uuid"

The ID of the history item associated with this Workflow Deployment’s LATEST Release Tag

input_variableslist of objects

The input variables this Workflow Deployment expects to receive values for when it is executed.

output_variableslist of objects

The output variables this Workflow Deployment produces values for when it’s executed.

statusenumOptional

The current status of the workflow deployment

  • ACTIVE - Active
  • ARCHIVED - Archived
Allowed values:
environmentenumOptional

The environment this workflow deployment is used in

  • DEVELOPMENT - Development
  • STAGING - Staging
  • PRODUCTION - Production
Allowed values:
descriptionstringOptional

A human-readable description of the workflow deployment