List Agents
freshservice.list_agents
ActionBusiness appsconnection required
Calls the Freshservice API with the connection's credentials.
List Freshservice agents, narrowed by the list filters the API accepts.
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
8 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 |
|---|---|---|---|---|---|
email Return only the agent with this email address. | string | No | — | email format | — |
work_phone_number Return only agents with this work phone number. | string | No | — | — | — |
mobile_phone_number Return only agents with this mobile phone number. | string | No | — | — | — |
active Return only active agents, or only deactivated ones when set to false. | boolean | No | — | — | — |
state Return only full-time or only occasional agents. | string | No | — | one of "fulltime", "occasional" | — |
per_page How many records Freshservice returns per page; it defaults to 30 and caps at 100. | number | No | — | 1–100 | 30 |
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,
"per_page": 30
}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
- 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 List Agents 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.