Search Opportunities
highlevel.search_opportunities
ActionCRM & salesconnection required
Calls the HighLevel API with the connection's credentials.
Search the sub-account's opportunities by pipeline, stage, status or text.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- HighLevel
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"} for a marketplace app, or {"access_token": "…"} for a Private Integration Token
- Config it needs
- location_id, user_type, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
12 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
query Free-text search over the name. | string | No | — | — | — |
pipeline_id Only this pipeline. | string | No | — | — | — |
pipeline_stage_id Only this stage. | string | No | — | — | — |
contact_id Only this contact's deals. | string | No | — | — | — |
status Only this status; 'all' is HighLevel's wildcard. | string | No | — | one of "open", "won", "lost", "abandoned", "all" | — |
assigned_to Only this user's deals. | string | No | — | — | — |
start_date Only deals from this date onwards, as HighLevel's 'date' filter. | string | No | — | — | — |
end_date Only deals up to this date. | string | No | — | — | — |
start_after_id Continue after this opportunity id — from the previous page's meta. | string | No | — | — | — |
page Which page to read, 1-based. | number | No | — | ≥ 1 | — |
limit Rows per page. HighLevel's own maximum is 100 and its default is 20. | number | No | 20 | 1–100 | — |
location_id Sub-account (location) id to act on instead of the connection's own. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"limit": 20
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items One entry per row HighLevel returned. | array | — |
count How many rows are in items. | number | — |
meta HighLevel's paging block, exactly as sent. | object | — |
total How many opportunities match in total. | number | — |
{
"count": 0,
"items": [],
"meta": {},
"total": 0
}Notes
- Scoped to the connection's location_id (the sub-account) unless the node overrides it.
See Search Opportunities run in a workflow.
In a technical demo we add the HighLevel connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.