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": {}
}

GET

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.

string

Full-text search on workflow names.

Headers

Authorization: Bearer wbk_your_api_key_here

Response

data

object

Show properties

workflows

array

Show Workflow object

string

Workflow UUID

name

string

Human-readable name

enabled

boolean

Active state

condition_entity

string

Entity type the workflow listens to

condition_field

string

Field name the condition evaluates

condition_operator

string

Operator (equals, contains, changed_to, …)

condition_value

string

Value compared against the field

action_type

string

send_email, create_task, send_channel_message, webhook, update_field

action_config

object

Action-specific configuration

max_triggers_per_day

integer

Daily cap before the workflow pauses itself

last_triggered_at

string

ISO 8601 timestamp, if any

created_at

string

ISO 8601 timestamp

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

Bulk Delete Deals Create Workflow

​Request

​Query Parameters

​Headers

​Response

​Example Response

​Errors

Request

Query Parameters

Headers

Response

Example Response

Errors