Goals: List goals
list_goalsRead-onlyIdempotent
List the user's financial goals.
Default scope: active + completed goals (cancelled goals are
hidden by default to avoid cluttering responses with abandoned
targets, which accumulate over time). Pass
``include_cancelled=True`` or an explicit ``status="cancelled"``
to see them.
Args:
status: Filter by a single status — "active", "completed",
or "cancelled". When provided, ``include_cancelled``
is ignored.
include_cancelled: If True (and ``status`` is None), include
cancelled goals in the default active+completed listing.
limit: Maximum number of goals to return (default: 50, max: 200).
offset: Number of goals to skip for pagination (default: 0).
Returns:
List of goals with progress info, plus ``total_count`` /
``has_more`` / ``offset`` / ``limit`` pagination metadata.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| status | No | ||
| include_cancelled | No |