Gets the public rooms on the server with optional filter.

POST {{baseUrl}}/publicRooms

Lists the public rooms on the server, with optional filter.

This API returns paginated responses. The rooms are ordered by the number of joined members, with the largest rooms first.

Note that this endpoint receives and returns the same format that is seen in the Client-Server API's POST /publicRooms endpoint.

Request Body

{"limit"=>10, "filter"=>{"generic_search_term"=>"foo"}, "include_all_networks"=>false, "third_party_instance_id"=>"irc"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"chunk":[{"avatar_url":"mxc://bleecker.street/CHEDDARandBRIE","guest_can_join":false,"name":"CHEESE","num_joined_members":37,"room_id":"!ol19s:bleecker.street","topic":"Tasty tasty cheese","world_readable":true,"join_rule":"public"}],"next_batch":"p190q","prev_batch":"p1902","total_room_count_estimate":115}