browse_groups
Search and filter public study groups by category, country, availability, open status, or camera verification. Retrieve paginated results with member counts and owner details.
Instructions
Browse public study groups.
:param category_id: Filter by category ID; ``0`` means all categories.
Default ``0``.
:type category_id: int
:param page: Page number. Default ``1``.
:type page: int
:param country_id: Filter by country ID; omit for all countries.
:type country_id: int | None
:param order_type: Sort order, e.g. ``"promotedAt"``. Default
``"promotedAt"``.
:type order_type: str
:param only_available: Show only groups with free slots. Default
``False``.
:type only_available: bool
:param only_open: Show only open groups. Default ``False``.
:type only_open: bool
:param only_cam: Show only groups with camera verification. Default
``False``.
:type only_cam: bool
:returns: List of group mappings with ``id``, ``title``, ``category``,
``owner``, ``slogan`` and ``member_count``.
:rtype: list[dict[str, Any]]
:raises RuntimeError: If YPT credentials are not configured.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| only_cam | No | ||
| only_open | No | ||
| country_id | No | ||
| order_type | No | promotedAt | |
| category_id | No | ||
| only_available | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |