vrchat_group_members
List VRChat group members with pagination, role filtering, and an optional cached snapshot of up to 10,000 members for complete data retrieval.
Instructions
List one page of compact group members by default. Use view=all only when a complete, cached snapshot is required (read-only, capped at 10,000).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | VRChat group-member sort expression. | |
| view | No | page fetches one bounded API page; all explicitly loads and caches a rate-aware snapshot capped at 10,000 members. | page |
| offset | No | Starting member offset when view=page. Ignored when view=all. | |
| roleId | No | Only include members with this role. | |
| groupId | No | Exact group ID. Provide groupId or shortCode. | |
| pageSize | No | Members to fetch when view=page. Ignored when view=all. | |
| shortCode | No | Exact group short code. Provide groupId or shortCode. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| view | Yes | ||
| stale | Yes | ||
| groupId | Yes | ||
| members | Yes | ||
| truncated | Yes | ||
| returnedMembers | Yes |