Skip to main content
GET
Get a definition

Authorizations

X-API-Key
string
header
required

Path Parameters

definition_id
string
required

Response

Successful Response

id
string
required
org_id
string
required
name
string
required
version
integer
required
status
string
required
inputs
DefinitionInput · object[]
required
variables
DefinitionVariable · object[]
required
steps
Step · object[]
required
webhooks
any[]
required
variable_bindings
Variable Bindings · object
template_ref
TemplateRef · object | null

Present when this flow was created for your account from a managed template, naming that template, the version it was created at and a digest of the content it started with. null for a flow you built yourself. Read-only — it is stamped when the flow is created and is not accepted when you create or update one.

searchable_inputs
string[]

Which of this flow's inputs a run can be found by. Name up to 5 inputs — or dotted paths into one, such as customer.phone — and each run of this flow records those values so you can look the run up by them later with attr.<key> on the executions list. The key is the path lowercased with dots replaced by underscores, so customer.phone is searched as attr.customer_phone. Values are captured when the run starts and never change afterwards, phone-shaped values are stored in international format, and anything longer than 256 characters is shortened. Naming an input this flow does not declare is rejected.