Workflow Leads
Get Variable Keys
Retrieve the dynamic variable keys derived from the columns of leads uploaded into a workflow.
GET
Get workflow variable keys
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
{{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
| Parameter | Description |
|---|---|
workflowId | The workflow ID, for example wfl_m3v7zb9rk2px. |
Errors
404 Not Foundis returned when the workflow does not exist.403 Forbiddenis returned when the API key cannot read workflows on this workspace.
Request
Response
Related endpoints
- List Workflow Leads: view enrolled leads.
- Add Lead to Workflow: programmatically enroll a single lead with arbitrary variables.
- Dynamic variables: guidance on referencing variables inside prompts.
Get workflow variable keys