List Appointments
freshworks_crm.list_appointments
ActionCRM & salesconnection required
Calls the Freshworks CRM API with the connection's credentials.
List appointments in one of Freshworks' appointment filters. Exactly one filter applies per request.
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 Which appointments to return. Freshworks' reference documents 'open' for upcoming appointments and 'complete' for past ones; accounts have also been seen to answer to 'upcoming' and 'past', so both pairs are offered and the documented one is the default. | string | Yes | — | one of "open", "complete", "upcoming", "past" | — |
include Comma-separated extras to embed: 'creater', 'targetable' or 'appointment_attendees'. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The appointments 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
}Notes
- Freshworks' reference names 'open' and 'complete' as the filter values, while some accounts answer to 'upcoming' and 'past'. If one pair returns an error, switch to the other; the endpoint itself is the same.
See List Appointments 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.