List Space Groups
list_space_groupsRetrieve space groups in a Circle community with optional name filtering, pagination, and bounded all-pages reads. Use it to fetch group records while tracking API quota and continuation state.
Instructions
List Space Groups. Reads community data. Supports bounded all_pages; every page counts against the API quota.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Filter by name | |
| page | No | Page number | |
| account | No | Named private Circle account; selects credentials, not a remote community ID. | |
| per_page | No | Number of records per page | |
| all_pages | No | Read bounded page/per_page pages; each request consumes API quota. Not a snapshot or guaranteed complete backup. | |
| max_items | No | Maximum returned records with all_pages=true, default 1000. At most 100 requests; output includes continuation state. |