List Workflows
curl --request GET \
--url https://api.example.com/v1/workflowsimport requests
url = "https://api.example.com/v1/workflows"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/workflows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/workflows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/workflows"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/workflows")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"workflows": [
{
"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,
"last_triggered_at": "<string>",
"created_at": "<string>"
}
]
},
"meta": {}
}Workflows
List Workflows
Paginate over automation workflows configured in the workspace
GET
/
v1
/
workflows
List Workflows
curl --request GET \
--url https://api.example.com/v1/workflowsimport requests
url = "https://api.example.com/v1/workflows"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/workflows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/workflows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/workflows"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/workflows")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"workflows": [
{
"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,
"last_triggered_at": "<string>",
"created_at": "<string>"
}
]
},
"meta": {}
}Request
Workflows are automation rules that fire when a condition on an entity is met. Use this endpoint to list, audit, or monitor workflow configuration without accessing the UI.Query Parameters
integer
default:"1"
Page number.
integer
default:"25"
Results per page. Maximum 100.
boolean
Filter to only enabled or disabled workflows.
string
Filter to workflows triggered on a specific entity type:
contact, deal, task, email, or meeting.string
Full-text search on workflow names.
Headers
Authorization: Bearer wbk_your_api_key_here
Response
object
Show properties
Show properties
array
Show Workflow object
Show Workflow object
string
Workflow UUID
string
Human-readable name
boolean
Active state
string
Entity type the workflow listens to
string
Field name the condition evaluates
string
Operator (
equals, contains, changed_to, …)string
Value compared against the field
string
send_email, create_task, send_channel_message, webhook, update_fieldobject
Action-specific configuration
integer
Daily cap before the workflow pauses itself
string
ISO 8601 timestamp, if any
string
ISO 8601 timestamp
object
Pagination metadata.
X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID.
curl "https://data.leadlex.com/functions/v1/api-gateway/v1/workflows?enabled=true" \
-H "Authorization: Bearer wbk_your_api_key_here"
import requests
API_KEY = "wbk_your_api_key_here"
BASE_URL = "https://data.leadlex.com/functions/v1/api-gateway"
r = requests.get(
f"{BASE_URL}/v1/workflows",
headers={"Authorization": f"Bearer {API_KEY}"},
params={"enabled": "true"},
)
for wf in r.json()["data"]["workflows"]:
print(wf["name"], wf["condition_entity"], wf["action_type"])
const res = await fetch(
'https://data.leadlex.com/functions/v1/api-gateway/v1/workflows?enabled=true',
{ headers: { Authorization: 'Bearer wbk_your_api_key_here' } },
);
const { data } = await res.json();
console.log(data.workflows.length);
Example Response
{
"data": {
"workflows": [
{
"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,
"last_triggered_at": "2026-04-17T09:31:00Z",
"created_at": "2026-03-01T08:00:00Z"
}
]
},
"meta": { "page": 1, "per_page": 25, "total": 5 }
}
Errors
| Status | Code | Description |
|---|---|---|
| 401 | invalid_key | Invalid or expired API key |
| 403 | insufficient_permissions | Missing read:workflows permission |
| 429 | rate_limited | Rate limit exceeded |