Skip to main content
Use community query APIs to browse communities by membership, category, tag filters where supported, and sort order. Use the platform’s search API or keyword option when you need name-based search.

Browse All Communities

Query communities with filtering and sorting options

Search Communities

Find specific communities using keyword-based search

Membership Filtering

Filter by user membership status and community access

Category Organization

Organize discovery by community categories and topics

Parameters

Query Parameters

Search Parameters

Filter Options

Membership Status Filtering

Control discovery based on the current user’s membership status:

Sorting Options

Organize community results to match your app’s discovery flow:

Category Filtering

Communities can be organized by categories to help users find relevant content faster. When a categoryId is specified, results are filtered to only include communities belonging to that category.

Tag Filtering

Communities can be tagged to describe their topics or purpose. TypeScript, Android, and Flutter expose a tags filter on the query/search builders shown below. The published iOS SDK used for this page does not expose a tag parameter on AmityCommunityQueryOptions or AmityCommunitySearchOptions.
Combine tag filtering with category and membership filters for precise discovery experiences.

Query Communities

The query-community API returns a collection of communities that match the provided filters.
TypeScript, iOS, and Flutter expose Live Collection style APIs. Android returns Flowable<PagingData<AmityCommunity>>.
Android’s getCommunities().withKeyword(...) is deprecated. Use searchCommunities(keyword = ...) on Android for keyword search.

Search Communities

Use search for name-based discovery. The parameter name differs by platform: TypeScript uses displayName, iOS uses keyword, Android passes keyword into searchCommunities(...), and Flutter uses .withKeyword(...) on the query builder.

Get Community Details

Retrieve detailed information about specific communities

Trending Communities

Discover popular and recommended communities

Community Categories

Learn about organizing communities with categories

Join Communities

Help users join discovered communities