Filtered Search Contacts
freshworks_crm.filtered_search_contacts
ActionCRM & salesconnection required
Calls the Freshworks CRM API with the connection's credentials.
Find contacts that exactly match a set of attribute rules, which Freshworks documents for contacts only.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Freshworks CRM
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- bundle_alias, domain, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 1 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 |
|---|---|---|---|---|---|
filter_rule The rules to apply, each {"attribute": …, "operator": …, "value": …}, for example {"attribute": "contact_email.email", "operator": "is_in", "value": "jane@example.com"}. | array | Yes | — | ≥ 1 characters; array of object | — |
per_page How many results to return; Freshworks defaults to 10 and allows at most 100. | number | No | 10 | 1–100 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"per_page": 10
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The contacts on this page, as Freshworks returned them. | array | — |
count How many records this page actually contains. | number | — |
total The total the response's 'meta' block reports, falling back to the size of this page when Freshworks sends no meta block. | number | — |
{
"count": 0,
"items": [],
"total": 0
}See Filtered Search Contacts run in a workflow.
In a technical demo we add the Freshworks CRM connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.