List Goals
clickup.list_goals
ActionBusiness appsconnection required
Calls the ClickUp API with the connection's credentials.
List the Goals in a Workspace, addressed by the team id, along with the Goal folders they are grouped into.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- ClickUp
- Secret shape
- the API token (pk_…), or {"token": "…"}
- Config it needs
- list_id
- 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 |
|---|---|---|---|---|---|
team_id The Workspace (team) id — the first number in any ClickUp URL, or clickup.list_teams. | string | Yes | — | — | — |
include_completed Include Goals that are already complete. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"include_completed": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items One entry per row ClickUp returned. | array | — |
count How many rows are in items. | number | — |
folders The Goal folders in the Workspace. | array | — |
{
"count": 0,
"folders": [],
"items": []
}See List Goals run in a workflow.
In a technical demo we add the ClickUp connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.