List Customers
helpscout.list_customers
ActionBusiness appsconnection required
Calls the Help Scout API with the connection's credentials.
Search and list customers by name, inbox, modification date or a Help Scout advanced-search query.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Help Scout
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}
- Config it needs
- mailbox_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 |
|---|---|---|---|---|---|
query A Help Scout advanced-search query, such as (email:"a@b.com"). | string | No | — | — | — |
mailbox_id The numeric inbox id to use instead of the connection's default inbox. | string | No | — | — | — |
first_name Only customers whose first name matches this value. | string | No | — | — | — |
last_name Only customers whose last name matches this value. | string | No | — | — | — |
modified_since Only customers modified after this ISO 8601 timestamp. | string | No | — | iso8601 format | — |
sort_field Which field to sort the results by. | string | No | — | one of "createdAt", "firstName", "lastName", "modifiedAt" | — |
sort_order Sort direction; Help Scout defaults to descending. | string | No | — | one of "asc", "desc" | — |
page Which 1-based page of results to fetch; leave blank for the first page. | number | No | — | ≥ 1 | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The rows on this page, exactly as Help Scout returned them. | array | — |
count How many rows are on this page. | number | — |
page The 1-based page number Help Scout answered with. | number | — |
size How many rows fit on one page. | number | — |
total_elements How many rows match across every page. | number | — |
total_pages How many pages the whole result set has. | number | — |
has_more True when a page after this one exists. | boolean | — |
{
"count": 0,
"has_more": false,
"items": [],
"page": 0,
"size": 0,
"total_elements": 0,
"total_pages": 0
}See List Customers run in a workflow.
In a technical demo we add the Help Scout connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.