Run Workflow Step Lookup

List the choices of one dropdown of a step in the workflow's draft, or find the one you mean with search, exactly as the editor loads them: the app's fixed options, a preset list, or a read from the app with the step's connection at its app version. A dropdown that depends on another (a project in a workspace) reads the step's arguments; send arguments to try values without saving them. Set the value with Update Workflow Step Configuration.

POST

Path

Path parameters

stringrequired

The workflow's id.

stringrequired

The step's id, from List Workflow Steps or Get Workflow Definition.

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.

Body

Arguments

stringrequired

The dropdown: arguments.<path>, options.filter.field, options.sort.field or options.customArguments.fields.

arguments.<path> for a list argument (arguments.contact.status), options.filter.field, options.sort.field, or options.customArguments.fields.

object

Argument values to use for this lookup only.

Argument values to use for this lookup only, merged into the step's as an update would be and not saved: a dropdown that depends on another follows an unsaved choice.

string

Text to find a choice by.

Find the choice that matches. Left out, every choice is listed.

number

Choices per page, 1 to 200.

Choices per page when listing, 1 to 200 (default 50).

Default: 50

number

Choices to skip.

Choices to skip when listing.

Default: 0

string

The environment a "By environment" step's connection is picked for, from List Environments. Defaults to the company's default environment.

The environment whose connection a "By environment" step reads with, from List Environments. Left out, the company's default environment.

Response fields

statusstring

listed (every choice, in pages), resolved (search matched one), ambiguous (search matched several), or notFound.

listed
resolved
ambiguous
notFound

reasonCodestring

NO_QUERY, EXACT_MATCH, STRONG_MATCH, MULTIPLE_HIGH_CONFIDENCE_CANDIDATES, INSUFFICIENT_CONFIDENCE, or NO_CANDIDATES.

selectedobject

The choice search matched, when resolved.

valuestring
The value to set.
labelstring
What the choice is called.

candidatesarray of objects

The choices: a page of them when listed, the best matches when ambiguous.

valuestring
The value to set.
labelstring
What the choice is called.

sourcestring

Where the choices came from: fixedOptions (the app's own list), list (countries, currencies or time zones), or lookupAction (a read from the app with the step's connection).

fixedOptions
list
lookupAction

pagingobject

The page of a listing.

limitnumber
Choices per page.
offsetnumber
Choices skipped.
totalnumber
How many choices there are.

hintsarray of objects

What to do next when search did not settle on one choice.

codestring
The reason code.
messagestring
What to do.