> For the complete documentation index, see [llms.txt](https://developer.perculus.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.perculus.com/v2-en/services/room-management/user-filer.md).

# Searching Rooms

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

<table><thead><tr><th width="146.9998779296875">Parameter</th><th width="106.66650390625">Type</th><th>Description</th></tr></thead><tbody><tr><td>query</td><td>string</td><td>Search keyword (searches in room name)</td></tr><tr><td>creator_email</td><td>string</td><td>Filter by creator's email address</td></tr><tr><td>created_after</td><td>string</td><td>Creation date start</td></tr><tr><td>created_before</td><td>string</td><td>Creation date end</td></tr><tr><td>user_id</td><td>string</td><td>Filter by specific user ID</td></tr><tr><td>page</td><td>int</td><td>Page number (default: 1)</td></tr><tr><td>size</td><td>int</td><td>Page size (default: 20, max: 100)</td></tr><tr><td>sort</td><td>string</td><td>Sorting (default: created_date desc)</td></tr></tbody></table>

**Example request:**

{% tabs %}
{% tab title="CURL" %}

```bash
curl -L -X GET 'https://<DOMAIN>/api/groups/xapi/room/search' \
-H 'Content-Type: application/json' \
-G \
-d 'query=test' \
-d 'creator_email=test@example.com' \
-d 'page=1' \
-d 'page_size=10' \
-d 'created_after=2025-01-01T00:00:00Z' \
-d 'created_before=2025-12-31T23:59:59Z'
```

{% endtab %}
{% endtabs %}

**Example response:**

```json
{
  "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
  }
}
```