Skip to content
Docs menu

Back to all methods

getGoals

read

The account's goals with a given status (active, future or past), every page fetched. Sends the `Sec-Fetch-Site: same-origin` header Garmin needs to return newer goal types. Defaults `status="active", **start=1**, limit=30`. `start` defaults to 1, NOT 0, because goal-service is 1-INDEXED and `start=0` silently returns `[]`; throws `GarminError` before any request for an invalid `status`. **Paginated, multi-call**: starting at `start`, fetches successive pages of `limit` entries (incrementing `start` by `limit` each call) until a page comes back empty/falsy, same fixed-page-size pattern as `ge…

getGoals(status?, start?, limit?)
ParameterTypeOptionalDescription
status"active" | "future" | "past"yes
startnumberyes
limitnumberyes

In Claude this is the get_goals tool.

Guide: profile-and-misc