WorkflowsWorkflow Deployments

Retrieve Workflow Deployment

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

Path parameters

idstringRequired
Either the Workflow Deployment's ID or its unique name

Response

This endpoint returns an object
id
string
name
string
A name that uniquely identifies this workflow deployment within its workspace
label
string
A human-readable label for the workflow deployment
created
datetime
last_deployed_on
datetime
last_deployed_history_item_id
string
The ID of the history item associated with this Workflow Deployment's LATEST Release Tag
input_variables
list of objects
The input variables this Workflow Deployment expects to receive values for when it is executed.
output_variables
list of objects
The output variables this Workflow Deployment produces values for when it's executed.
status
enumOptional

The current status of the workflow deployment

  • ACTIVE - Active
  • ARCHIVED - Archived
Allowed values: ACTIVEARCHIVED
environment
enumOptional

The environment this workflow deployment is used in

  • DEVELOPMENT - Development
  • STAGING - Staging
  • PRODUCTION - Production
Allowed values: DEVELOPMENTSTAGINGPRODUCTION
Built with