Search Contacts
highlevel.search_contacts
ActionCRM & salesconnection required
Calls the HighLevel API with the connection's credentials.
Run HighLevel's advanced contact search with a filter body.
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
1 field, 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 |
|---|---|---|---|---|---|
body The search body as JSON — HighLevel's own filters, sort, page and pageLimit keys. locationId is filled in from the connection when it is absent. | object | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items One entry per row HighLevel returned. | array | — |
count How many rows are in items. | number | — |
total HighLevel's own total, when it reports one. | number | — |
response The whole search response as sent. | object | — |
{
"count": 0,
"items": [],
"response": {},
"total": 0
}Notes
- Scoped to the connection's location_id (the sub-account) unless the node overrides it.
- HighLevel does not publish a schema for this body, so it is passed through exactly as written — check it against HighLevel's search documentation, not against this node.
See Search Contacts 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.