Skip to main content
GET
/
v1
/
workflows
List Workflows
curl --request GET \
  --url https://api.example.com/v1/workflows
{
  "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

​
page
integer
default:"1"
Page number.
​
per_page
integer
default:"25"
Results per page. Maximum 100.
​
enabled
boolean
Filter to only enabled or disabled workflows.
​
condition_entity
string
Filter to workflows triggered on a specific entity type: contact, deal, task, email, or meeting.
​
search
string
Full-text search on workflow names.

​
Headers

Authorization: Bearer wbk_your_api_key_here

​
Response

​
data
object
​
meta
object
Pagination metadata.
Responses include 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"

​
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

StatusCodeDescription
401invalid_keyInvalid or expired API key
403insufficient_permissionsMissing read:workflows permission
429rate_limitedRate limit exceeded