List the public and private rooms whose names match a given string, excluding discussions, DMs, and omnichannel rooms. The endpoint is valuable when performing search operations. It returns only rooms that the user belongs to. This endpoint includes pagination query parameters.
The authToken of the authenticated user.
The userId of the authenticated user.
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.
List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, {"value": -1, "_id": 1}. Refer to the official documentation to learn more.
The search term to be completed. It only applies to the room name.
OK
{
"items": [
{
"_id": "66c82e1e237405fc05fc1ef4",
"fname": "api-team",
"name": "api-team",
"t": "c"
},
{
"_id": "66c88dae237405fc05fc1f06",
"fname": "api-team2",
"name": "api-team2",
"t": "p"
}
],
"total": 4,
"success": true
}Bad Request
{
"success": false,
"error": "The 'selector' param is required"
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}