d94e0e0f1821
List communities
Lists all communities with full details, or performs a fast community search with minimal data. This endpoint has optional Signed Fetch authentication. When signed, it includes properties related to the authenticated user in its response. This endpoint excludes unlisted communities from results. Use direct community access (GET /v1/communities/{id}) to retrieve unlisted communities.
Minimal Mode (minimal=true): When minimal=true is set, authentication is required and only the search parameter is used:
- Returns community id, name, membersCount, and privacy for fast lookups
- Requires search parameter with minimum 3 characters
- Maximum 50 results per request
- Supports pagination with limit and offset parameters
- Other filter parameters are ignored
Visibility Rules (Minimal Mode):
- Public and Private communities: searchable by anyone
- Unlisted communities: only searchable by their members
Search Behavior (Minimal Mode):
- Matches community names starting with the search term
- Also matches words in the middle of the name (after a space)
Query parameters
Number of communities per page. When minimal=true, max is 50.
Number of communities to skip.
Search term to filter communities by name. Required when minimal=true (minimum 3 characters).
When true, returns community id, name, membersCount, and privacy for fast lookups. Requires authentication and search parameter with minimum 3 characters. Supports pagination with limit (max 50) and offset parameters. Other filter parameters (onlyMemberOf, onlyWithActiveVoiceChat, roles) are ignored.
Filter communities where the authenticated user is a member. Ignored when minimal=true.
Filter to show only communities with active voice chats. Ignored when minimal=true.
Filter communities by the authenticated user's role (can specify multiple roles). Ignored when minimal=true.
Response
Communities found