Workflow Leads
Get Workflow Lead Variables
List dynamic variable keys found in workflow leads.
GET
Get Workflow Lead Variables
Read only
Returns the list of dynamic variable keys derived from the column headers of the lead files uploaded to this workflow. These keys are what you can reference inside an agent’s prompt using the
Recommended. This endpoint is part of the public
/v1 API reference and is the supported path for new integrations. See the migration guide for versioning guidance.{{variable_name}} template syntax. For example, if a lead file contained the columns phone_number, name, city, and product, this endpoint returns the variable list ["name", "city", "product"]: phone_number is excluded because it is reserved as the dial target rather than a personalization variable.
When to use this
- Prompt editors: populate an autocomplete or “available variables” panel so the prompt author can only reference variables that actually exist on this workflow’s leads.
- Validation pipelines: verify a prompt template before publishing an agent change. Reject the deploy if it references a
{{variable_name}}that does not appear in this list. - Workflow audits: confirm a newly uploaded lead file produces the columns the prompt expects, especially after editing the upload schema.
Path parameters
Errors
404 Not Foundis returned when the workflow does not exist.403 Forbiddenis returned when the API key cannot read workflows on this workspace.
Related endpoints
- List Workflow Leads: view enrolled leads.
- Upload Workflow Leads: upload a CSV or Excel file with dynamic variable columns.
- Dynamic variables: guidance on referencing variables inside prompts.
Get Workflow Lead Variables