get_workflow_options

get_workflow_options returns the values one place in a workflow block can take for your tenant — a setting, a place inside a setting, or an input typed by hand. Use it for every setting or input that get_workflow_blocks (full detail) marks with options, and for every place a setting’s lists names.

Caution

Never write a CRM object, field, filter value, or data name from memory. An unknown value is refused when you save the workflow. Resolve it here first.

What counts as a “place”

Place	Example parameter value
A setting	object, fields
A place inside a setting	filters.field, filters.value, query.clauses.field
An input typed by hand	inputs.country
What a trigger’s own field is (its kind)	columns.ontology, schema.properties.ontology

For a place that lives inside an entry — a CRM filter’s value, say — pass the rest of the entry in at (e.g. {"field": "Industry"} to list the values of Industry) so the options are scoped to it.

Closed vs. open lists

The answer says what kind of list you’re looking at:

• closed: true — only these values are valid. Write one of them; a value outside the list is refused on save.
• closed: false — the values are suggestions. Use one of them, or the person’s own value.

Each option carries a label (what to call it when you talk to the user) and a value (what the step actually stores). depends_on names the settings the list is read from — pass them in parameters and re-query when one changes.

Long lists

Some lists are large — OnFire’s company and people data holds thousands of technology, persona and growth names. The answer returns the best matches first, up to limit, with a total and a per-kind count. Narrow it with search (e.g. "crowdstrike") or kind (e.g. field for plain columns such as an employee count).

Inputs

Parameter	Type	Required	Description
block_type	string	Yes	The block whose place you’re resolving, e.g. source.crm_records.
parameter	string	Yes	The place whose values you need — a setting, a dotted place inside one, or inputs.<name>.
parameters	object	No	The step’s other settings the list depends on, e.g. {"object": "Lead"} to list a Lead’s fields.
at	object	No	The rest of the entry being written, when the place is inside one.
search	string	No	Words to look for; the value itself ranks first.
kind	string	No	Return only options of this kind (the answer’s kinds names them).
limit	integer	No	How many to return (1–500, default 50).
target_tenant_id	string	No	Super-tenant administrators only.

Notes

• Set what a trigger’s field is (its kind, via columns.ontology or schema.properties.ontology) only when the user has said or confirmed it — never guess it.
• picking restates the closed/open rule in a line; title names the list.