v1

latestSwagger 2.0AGPL-3.02026-07-17413281.9 KB
search

Search rooms

Full-text room search. Pass the query and options as query params here: ?q= (query), ?l= (limit), ?o= (offset), ?s= (sort), ?rt= (room type). The same handler also answers a positional path form for convenience, /search/{q}, /search/{q}/{l}, and so on up to /search/{q}/{l}/{o}/{s}/{rt}, filling those five slots left to right. An empty result set is a 204, not an empty 200.

get/search

Query parameters

qstring

Search query

linteger

Limit

ointeger

Offset

sstring

Sort field

rtstring

Room type filter

Response

Matching rooms

aliasstring
avatarstring
avatar_urlstring
guest_can_joinboolean
idstring
join_rulestring
languagestring
membersinteger
namestring
room_typestring
serverstring

server of origin

serversstring

comma-separated list of servers

topicstring
typestring
world_readableboolean