Contacts
Companies
Deals
Pipelines
Lists
Tags
Campaigns
- GETList Campaigns
- POSTCreate Campaign
- GETGet Campaign
- PATCHUpdate Campaign
- DELDelete Campaign
- POSTStart Campaign
- POSTPause Campaign
- GETList Campaign Contacts
- POSTAdd Contacts to Campaign
- DELRemove Contact from Campaign
- GETList Campaign Steps
- POSTCreate Campaign Step
- PATCHUpdate Campaign Step
- DELDelete Campaign Step
- GETCampaign Stats
- GETCampaign Event Stream
Users
Stats & Analytics
Lexi AI
Audit Logs
AI Analysis
Documents
Import & Export
Workflows
Events
Get Workflow
curl --request GET \
--url https://api.example.com/v1/workflows/{id}{
"data": {
"id": "<string>",
"name": "<string>",
"enabled": true,
"condition_entity": "<string>",
"condition_field": "<string>",
"condition_operator": "<string>",
"condition_value": "<string>",
"action_type": "<string>",
"action_config": {},
"max_triggers_per_day": 123,
"triggers_today": 123,
"last_triggered_at": "<string>",
"auto_disabled_reason": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}Workflows
Get Workflow
Retrieve a single workflow configuration and its runtime state
GET
/
v1
/
workflows
/
{id}
Get Workflow
curl --request GET \
--url https://api.example.com/v1/workflows/{id}{
"data": {
"id": "<string>",
"name": "<string>",
"enabled": true,
"condition_entity": "<string>",
"condition_field": "<string>",
"condition_operator": "<string>",
"condition_value": "<string>",
"action_type": "<string>",
"action_config": {},
"max_triggers_per_day": 123,
"triggers_today": 123,
"last_triggered_at": "<string>",
"auto_disabled_reason": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}Request
Path Parameters
Workflow UUID.
Headers
Authorization: Bearer wbk_your_api_key_here
Response
Show properties
Show properties
Workflow UUID
Name
Active state
Entity type
Field evaluated
Operator
Value compared against
Action type
Action configuration
Daily cap
Number of times triggered in the current day
ISO 8601 timestamp, if any
If auto-disabled, why (e.g.
daily_cap_exceeded)ISO 8601 timestamp
ISO 8601 timestamp
X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID.
curl https://data.leadlex.com/functions/v1/api-gateway/v1/workflows/wf_01HY1 \
-H "Authorization: Bearer wbk_your_api_key_here"
Example Response
{
"data": {
"id": "wf_01HY1",
"name": "Notify owner on lost deals",
"enabled": true,
"condition_entity": "deal",
"condition_field": "status",
"condition_operator": "changed_to",
"condition_value": "lost",
"action_type": "send_channel_message",
"action_config": {
"channel": "slack",
"recipient": "{{deal.owner.slack_id}}",
"message": "Deal {{deal.name}} was marked lost."
},
"max_triggers_per_day": 100,
"triggers_today": 3,
"last_triggered_at": "2026-04-17T09:31:00Z",
"auto_disabled_reason": null,
"created_at": "2026-03-01T08:00:00Z",
"updated_at": "2026-04-17T09:31:00Z"
}
}
Errors
| Status | Code | Description |
|---|---|---|
| 401 | invalid_key | Invalid or expired API key |
| 403 | insufficient_permissions | Missing read:workflows permission |
| 404 | not_found | Workflow not found |
| 429 | rate_limited | Rate limit exceeded |
⌘I