Skip to content
Open Gravity
Browse docslist_goals
View as Markdown

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:

FieldTypeDescription
idstringGoal ID
beneficiaryobject or null, optionalFixed owner-scoped { personId, name } when the goal is for someone in your Rolodex. Preserve this identity; such goals stay private.
textstringThe goal, as its selected groups read it
additionalContextstringYour private details. Never repeat them where other members could read them.
contextRevisionIdstringThe current private-details revision, needed for writes
scopeVersionnumberThe current version, needed for writes
clarificationQuestionstring or nullA question Gravity asked about the goal. No search starts while one is open.
suggestedByGravitybooleanGravity wrote this goal and you haven't reworded it
createdAtstringISO 8601 timestamp
retiredAtstring or nullAlways null here, since ended goals aren't listed
isOwnerbooleanAlways true here
memberId, ownerName, ownerImageUrlThe owner, which is you

Example#

json
{}

Result (synthetic data):

json
{
  "goals": [
    {
      "id": "00000000-0000-4000-a000-000000000001",
      "memberId": "00000000-0000-4000-a000-000000000003",
      "beneficiary": null,
      "ownerName": "Synthetic member",
      "ownerImageUrl": null,
      "text": "Find design partners",
      "additionalContext": "Synthetic private details",
      "clarificationQuestion": null,
      "contextRevisionId": "00000000-0000-4000-a000-000000000002",
      "scopeVersion": 2,
      "suggestedByGravity": false,
      "retiredAt": null,
      "createdAt": "2026-10-09T00:00:00.000Z",
      "isOwner": true,
      "version": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}

Related#