Get Workflow Inputs

Read what a run of the workflow takes, where the editor keeps it. A function (type function) answers its inputs, from its draft, with the draft's revision; steps read them as {{ function.inputs.<key> }}. Its workflow variables come in variables, in the shape a workflow's inputs have; steps read them as {{ workflow.inputs.<key> }}. Any other workflow (type workflow) answers its variables and, outside Embedded workflows, each one's value per environment id; steps read them as {{ workflow.inputs.<key> }}. issues lists what is kept as stored.

GET

Path

Path parameters

stringrequired

The workflow's id, from List Workflows.

Headers

Optional headers

string

Optional. The id of a child organization of your API key's company to act on. Leave it out to act on the key's own company. See Child organizations.

Response fields

typestring

function: a function's inputs, part of its draft (send its revision in If-Match to change them), and its workflow variables; workflow: the workflow's variables, with their value in each environment.

function
workflow

inputsarray of objects

Every input, in order.

keystring
The name a step reads it by: {{ function.inputs.<key> }} or {{ workflow.inputs.<key> }}. Made from the label when left out, as the editor makes it; an array variable's ends in "[]". Absent only on an input kept as stored ({ $legacy, ref }).
labelstring
The name the editor shows.
typestring
The data type: string, number, boolean, date, list (one of its choices), array, object, or file. Left out on a write: string.
- string
- number
- boolean
- date
- list
- array
- object
- file
descriptionstring
Function inputs: what the input is for.
testValueobject
Function inputs: the value a run from the editor uses, as a step argument of the same type takes it (a template may use system, memory, workflow.inputs and integration.metadata).
requiredboolean
Workflow variables (not boolean): every environment whose values change needs a value.
errorMessagestring
Workflow variables: the message shown when a value is refused.
placeholderstring
Workflow variables (not boolean): the hint in an empty field.
sensitiveboolean
Workflow string variables: masked in the editor; its values read as { $sensitive, ref } and are kept when sent back so.
minLengthnumber
Workflow string variables: the shortest value.
maxLengthnumber
Workflow string variables: the longest value.
patternstring
Workflow string variables: a regular expression a value must match.
numberTypestring
Workflow number variables: integer or decimal (the default).
- integer
- decimal
minnumber
Workflow number variables: the smallest value.
maxnumber
Workflow number variables: the largest value.
itemTypestring
Workflow list variables: the type of the choice values, string, number, boolean or date.
- string
- number
- boolean
- date
choicesarray
Workflow list variables: the choices, in order. An app lookup list reads as { $legacy, ref }.
- valueobject
  The value a run gets, typed as itemType.
- labelstring
  What the editor shows.
valuesobject
Workflow variables outside Embedded workflows: the value in each environment, by environment id (List Environments). A run in an environment gets its value.

variablesarray of objects

Functions only: the function's workflow variables, in order, in the shape a workflow's inputs have (values per environment included); steps read them as {{ workflow.inputs.<key> }}. Live at once when changed, with no If-Match.

keystring
The name a step reads it by: {{ function.inputs.<key> }} or {{ workflow.inputs.<key> }}. Made from the label when left out, as the editor makes it; an array variable's ends in "[]". Absent only on an input kept as stored ({ $legacy, ref }).
labelstring
The name the editor shows.
typestring
The data type: string, number, boolean, date, list (one of its choices), array, object, or file. Left out on a write: string.
- string
- number
- boolean
- date
- list
- array
- object
- file
descriptionstring
Function inputs: what the input is for.
testValueobject
Function inputs: the value a run from the editor uses, as a step argument of the same type takes it (a template may use system, memory, workflow.inputs and integration.metadata).
requiredboolean
Workflow variables (not boolean): every environment whose values change needs a value.
errorMessagestring
Workflow variables: the message shown when a value is refused.
placeholderstring
Workflow variables (not boolean): the hint in an empty field.
sensitiveboolean
Workflow string variables: masked in the editor; its values read as { $sensitive, ref } and are kept when sent back so.
minLengthnumber
Workflow string variables: the shortest value.
maxLengthnumber
Workflow string variables: the longest value.
patternstring
Workflow string variables: a regular expression a value must match.
numberTypestring
Workflow number variables: integer or decimal (the default).
- integer
- decimal
minnumber
Workflow number variables: the smallest value.
maxnumber
Workflow number variables: the largest value.
itemTypestring
Workflow list variables: the type of the choice values, string, number, boolean or date.
- string
- number
- boolean
- date
choicesarray
Workflow list variables: the choices, in order. An app lookup list reads as { $legacy, ref }.
- valueobject
  The value a run gets, typed as itemType.
- labelstring
  What the editor shows.
valuesobject
Workflow variables outside Embedded workflows: the value in each environment, by environment id (List Environments). A run in an environment gets its value.

issuesarray of objects

Warnings about what is stored: values kept as stored, labels the editor no longer reads, duplicate keys.

severitystring
error refuses a write; warning does not.
- error
- warning
codestring
What is wrong, UPPER_SNAKE (LEGACY_VALUE_PRESERVED, LEGACY_LABEL, DUPLICATE_KEY, ...).
pathstring
Where, as a JSON Pointer into the answer (/inputs/2/values/Ev4kR8mTq2Lx); empty for the whole list.
messagestring
What is wrong, for a person.

revisionstring

Functions only: the draft's revision. Send it in If-Match on your next change to the draft.