Search Rooms
Search for rooms, querying name, description, and specified keywords.
Search rooms according to the specified criteria.
The search query object.
The search query. Matches the room name and description.
"automobile"
A list of room tag labels whose values will be queried.
Restrict the search to active/inactive rooms. If unspecified, search all rooms.
true
Restrict the search to private rooms. If unspecified, search all rooms.
true
Sort algorithm to be used. Supports two values: "BASIC" (legacy algorithm) and "RELEVANCE" (enhanced algorithm).
"RELEVANCE"
Restrict the search to the specific room subtype. Valid values are: EMAIL
"EMAIL"
OK
The total number of rooms matched by the search.
2
The number of skipped results.
0
The number of returned results.
10
Room Query Object. Used to specify the parameters for room search.
A list of rooms matched by the query.
Detailed counts of matched rooms per search criterion.
📘 Room Search ScopeRoom search is performed on the set of:
All rooms that the calling user is a member of (private or public, active or inactive)
All active public rooms
Private rooms that the calling user is not a member of, where the room is set to be visible in search, is active and the room does not contain any user with whom the calling user has an information barrier
Note: visit Overview for an overview of streams.
🚧 Room Description SearchThe description is only searched for hashtags and cashtags containing the search query. For example if
query
werefoo
and the description of a room contained "foo", this room would not be returned in the search results; however, if the description contained "#foo", this room would be returned in the search results.
Last updated