Skip to content
Browse docslist_goal_search_networks

list_goal_search_networks

Reads a page of eligible or unfinished network identities for an owned goal's current search.

Annotations: readOnlyHint: true · destructiveHint: false · idempotentHint: true · openWorldHint: false

Inputs#

InputRequiredTypeDescription
goalIdyesstringExact goal UUID from an authorized list or retained reference
statenostringeligible (default, new or updated networks) or failed (unfinished networks)
pageSizenointegerDefault 20, also for 0; capped at 100; negative or fractional values are invalid
pageTokennostringReturned continuation; omit or use an empty string for the first page

Returns#

networks and nextPageToken. Each network contains stable memberId, displayName, isCurrentMember, and reason (new, updated, or failed). These are coarse group-member identities, never contacts, private relationship evidence, or claims of willingness.

Order is the current member first, then name and stable member identity. Only an empty token means completion. Continue through empty pages, keeping the goal and state unchanged. Tokens are private, actor/query-bound, and expire after one hour. These are live reads; if the previous position disappears, restart the list. An owned goal with no current search returns an empty complete list. Inaccessible or other members' goals return unavailable.

Reading changes nothing. Use get_goal_search for counts and progress.

Example#

json
{
  "goalId": "00000000-0000-4000-a000-000000000001"
}

Result (synthetic data):

json
{
  "networks": [
    {
      "memberId": "00000000-0000-4000-a000-000000000003",
      "displayName": "Synthetic member",
      "isCurrentMember": true,
      "reason": "updated"
    }
  ],
  "nextPageToken": ""
}