Skip to main content
GET
Before you can execute a job, you must know what inputs it expects. This endpoint returns the workflow object, including its name, description, blueprint, and the jobPayloadSchema that defines all of the workflow’s inputs. By default, the response describes the latest active version of the workflow. To inspect a specific historical version, pass either the version number or the workflowVersionId UUID as a query parameter.

Path Parameters

string
required
The unique identifier of the workflow to retrieve details for

Query Parameters

number
Workflow version number to retrieve. Omit to use the latest active version.
string
Specific workflow version UUID. Takes precedence over version when both are supplied.

Headers

string
required
Your API authentication key

Response

The jobPayloadSchema object defines all workflow inputs, their unique variable names (e.g., workflow_input_we4tej0ly), and their data types.
object
An object containing all workflow input definitions

Supported Data Types