Search Assets
freshservice.search_assets
ActionBusiness appsconnection required
Calls the Freshservice API with the connection's credentials.
Search Freshservice assets across the indexed identifying fields.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Freshservice
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- domain, workspace_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 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 |
|---|---|---|---|---|---|
search Search expression over name, asset_tag, serial_number, mac_addresses, ip_addresses, uuid, item_id or imei_number, such as name:'dell'. | string | Yes | — | — | name:'dell' |
trashed Search the assets that are in the trash instead of the live ones. | boolean | No | — | — | — |
page Which page to start from; Freshservice numbers pages from 1. | number | No | — | ≥ 1 | 1 |
max_pages How many 'rel=next' link-header pages to follow before stopping and reporting a cursor. | number | No | 1 | ≥ 1 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"max_pages": 1,
"page": 1,
"search": "name:'dell'"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records Freshservice returned across the pages that were read. | array | — |
count How many records are in 'items'. | number | — |
pages How many pages were actually fetched. | number | — |
next_page The page number to resume from, or null at the end. | number | — |
next_url The 'rel=next' URL Freshservice sent, or empty at the end. | string | — |
{
"count": 0,
"items": [],
"next_page": 0,
"next_url": "",
"pages": 0
}Notes
- Only the indexed identifying fields are searchable here; use freshservice.filter_assets for type, location, department or state.
- Search results cannot be sorted and a change can take a few minutes to index.
- Freshservice sends a 'rel=next' link header only while another page exists, so an empty next_page is the end of the collection, not a truncated answer.
- A page holds 30 records by default and 100 at most.
See Search Assets run in a workflow.
In a technical demo we add the Freshservice connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.