Search
freshworks_crm.search
ActionCRM & salesconnection required
Calls the Freshworks CRM API with the connection's credentials.
Search records by name or email across the entities you name, which is the same search the Freshworks search box runs.
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
3 fields, 2 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 The text to search for. | string | Yes | — | — | — |
entities Comma-separated entities to search, from user, contact, sales_account and deal, or a custom module's own entity name. | string | Yes | — | — | contact |
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.
{
"entities": "contact",
"per_page": 10
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The matches, each carrying its own 'type'. | array | — |
count How many matches were returned. | number | — |
{
"count": 0,
"items": []
}Notes
- Freshworks answers with an empty array when the entity name is wrong (for instance 'contacts' instead of 'contact') rather than reporting an error.
See Search 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.