Skip to content
Browse docslist_groups

list_groups

List your current group memberships. Reading changes nothing and starts no search.

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

Inputs#

FieldRequiredTypeMeaning
pageSizenointegerDefault 20 (also for 0), capped at 100. Negative or fractional values are invalid.
pageTokennostringOmit or use an empty string to start. For continuation, pass the preceding nextPageToken unchanged.

Result#

Each summary contains only publicId, name, and your role (member or moderator). Groups are ordered by name, case-insensitively, then public ID. An empty collection is successful. Read get_group for one group’s details, list_group_members for its roster, or list_group_goals for its shared goals.

Continuation#

nextPageToken is always present. Only an empty string means the list is complete. Continue even if a page is short or empty when its token is nonempty. Tokens expire after one hour and are bound to this operation, authenticated member, and group where applicable. Keep all arguments other than pageSize unchanged. Invalid, expired, or mismatched tokens return invalid_argument; restart without a token. Each page rechecks current membership. These are live reads, not a snapshot across pages. Within a tool budget, report partial coverage truthfully rather than claiming completion.

Example#

json
{
  "pageSize": 20
}
json
{
  "groups": [
    {
      "publicId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "name": "Synthetic founders",
      "role": "member"
    }
  ],
  "nextPageToken": ""
}