From a91ed23ac385186045088c2ec0019c7cea7591ff Mon Sep 17 00:00:00 2001
From: richvdh
Parameters
The following query parameters are available:
from
- Offset in the returned list. Defaults to 0
.limit
- Maximum amount of rooms to return. Defaults to 100
.order_by
- The method in which to sort the returned list of rooms. Valid values are:
+from
- Offset in the returned list. Defaults to 0
.
limit
- Maximum amount of rooms to return. Defaults to 100
.
order_by
- The method in which to sort the returned list of rooms. Valid values are:
alphabetical
- Same as name
. This is deprecated.size
- Same as joined_members
. This is deprecated.state_events
- Rooms are ordered by number of state events. Largest to smallest.dir
- Direction of room order. Either f
for forwards or b
for backwards. Setting
-this value to b
will reverse the above sort order. Defaults to f
.search_term
- Filter rooms by their room name. Search term can be contained in any
-part of the room name. Defaults to no filtering.dir
- Direction of room order. Either f
for forwards or b
for backwards. Setting
+this value to b
will reverse the above sort order. Defaults to f
.
search_term
- Filter rooms by their room name, canonical alias and room id.
+Specifically, rooms are selected if the search term is contained in
Defaults to no filtering.
+Response
The following fields are possible in the JSON response body:
-- cgit 1.5.1