🔍Searching Rooms

Below, you can find the parameters you can use when searching for rooms:

Parameter	Type	Description
query	string	Search keyword (searches in room name)
creator_email	string	Filter by creator's email address
created_after	string	Creation date start
created_before	string	Creation date end
user_id	string	Filter by specific user ID
page	int	Page number (default: 1)
size	int	Page size (default: 20, max: 100)
sort	string	Sorting (default: created_date desc)

Example request:

CURL

curl -L -X GET 'https://<DOMAIN>/xapi/v2/room/search' \
-H 'Content-Type: application/json' \
-G \
-d 'query=test' \
-d '[email protected]' \
-d 'page=1' \
-d 'page_size=10' \
-d 'created_after=2025-01-01T00:00:00Z' \
-d 'created_before=2025-12-31T23:59:59Z'

Example response:

{
  "data": [
    {
      "room_guid": "61E3D504-13EE-447F-9B36-6686C5C39FEB",
      "name": "Test Room",
      "lang": "en-US",
      "url": "https://yourdomain.com/groups/room/test-room_{0}",
      "created_date": "2025-08-18T12:48:00",
      "tags": "test, api",
      "inaccessible_replay": false,
      "allow_recording": true,
      "ui_options": {
        "allow_rating": true,
        "preparation_time": 15,
        "session_duration": 60,
        "chat": {
          "offMessageModule": false,
          "offGeneralMsging": false,
          "offGeneralMsgLimitForUser": false,
          "offSpecialMsging": false,
          "offSpecialMsgToAdmin": false,
          "offSpecialMsgToUser": false,
          "offNewMsgSound": false,
          "offClearForReplay": false,
          "onNewMsgSoundInAll": false,
          "onNewMsgNotifyInAll": false
        },
        "duration": {
          "allowExtendTime": true,
          "useRemainingTime": false
        },
        "allow_users_stream_self_cam_mic": true,
        "hide_user_streams": false,
        "enable_attendance_check": true,
        "enable_simultaneous_interpretation": false,
        "enable_simultaneous_interpretation_for_users": false,
        "start_active": false,
        "return_url": "",
        "allow_reactions": true
      }
    }
  ],
  "pagination": {
    "page": 1,
    "size": 10,
    "totalCount": 25,
    "totalPages": 3,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}