Tools / list_goals
list_goals
Lists your active goals, private ones included.
Annotations: readOnlyHint: true · destructiveHint: false · idempotentHint: true · openWorldHint: false
When to use it#
Start here for any request about "my goal". Ended goals aren't listed, and neither are other members' goals. Selected groups aren't included. Read them with get_goal.
Inputs#
No inputs.
Returns#
{ "goals": [...] }, newest first. Each goal has:
| Field | Type | Description |
|---|---|---|
id | string | Goal ID |
text | string | The goal, as its selected groups read it |
additionalContext | string | Your private details. Never repeat them where other members could read them. |
contextRevisionId | string | The current private-details revision, needed for writes |
scopeVersion | number | The current version, needed for writes |
clarificationQuestion | string or null | A question Gravity asked about the goal. No search starts while one is open. |
suggestedByGravity | boolean | Gravity wrote this goal and you haven't reworded it |
createdAt | string | ISO 8601 timestamp |
retiredAt | string or null | Always null here, since ended goals aren't listed |
isOwner | boolean | Always true here |
memberId, ownerName, ownerImageUrl | The owner, which is you |
Example#
json
{}
Trimmed result:
json
{
"goals": [
{
"id": "6f1c2a3e-4b5d-4e6f-8a7b-9c0d1e2f3a4b",
"text": "Meet seed investors who back developer tools.",
"additionalContext": "Raising $2M at a $12M cap. 40 paying teams.",
"contextRevisionId": "c2d3e4f5-a6b7-4c8d-b9e0-f1a2b3c4d5e6",
"scopeVersion": 3,
"clarificationQuestion": null,
"suggestedByGravity": false,
"isOwner": true
}
]
}
Related#
get_goalreads one goal with its audience and search state.- Goals and audiences explains private details and versions.