User-related API environment

Pre-live user-related API docs

These pages describe the Pre-live user-related API stack.

Use pre-live OAuth credentials, pre-live API base URLs, and pre-live app URLs when following this documentation. Keep your OAuth flow, API requests, callback URLs, and manual testing within the pre-live environment.

• Use prelive.quran.com for auth-related testing.
• Use prelive.quranreflect.org for Quran Reflect paths where applicable.
• Do not mix production sessions or production user data with pre-live testing.

Search rooms

Search for public groups and pages by name or description. Results can be filtered by room type.

Query Parameters

query string

Search term for room name/description

page number

Page number (default: 1)

limit number

Results per page (default: 10)

roomType string

Filter by room type: GROUP or PAGE

Responses

• 200

---

Matching rooms with pagination

application/json

Schema

Example (from schema)

Example

---

Schema

total number required
currentPage number required
limit number required
pages number required
data object[] required
Array [
id number required
name string required
description string required
roomType string required
isActive boolean required
isVerified boolean required
isPublic boolean required
hideFollowJoinButton boolean required
isOwner boolean required
isAdmin boolean required
ownerId string required
postsCount number required
membersCount number required
url string
avatarUrls object required
thumb string
original string
createdAt date-time
isMember boolean
subdomain string
country string
]

{
  "total": 10,
  "currentPage": 1,
  "limit": 10,
  "pages": 1,
  "data": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "roomType": "string",
      "isActive": true,
      "isVerified": true,
      "isPublic": true,
      "hideFollowJoinButton": true,
      "isOwner": true,
      "isAdmin": true,
      "ownerId": "string",
      "postsCount": 0,
      "membersCount": 0,
      "url": "string",
      "avatarUrls": {
        "thumb": "string",
        "original": "string"
      },
      "createdAt": "2026-06-14T11:33:53.472Z",
      "isMember": true,
      "subdomain": "string",
      "country": "string"
    }
  ]
}

{
  "total": 10,
  "currentPage": 1,
  "limit": 10,
  "pages": 1,
  "data": [
    {
      "id": 1,
      "name": "string",
      "description": "string",
      "roomType": "string",
      "isActive": true,
      "isVerified": true,
      "isPublic": true,
      "hideFollowJoinButton": true,
      "isOwner": true,
      "isAdmin": true,
      "ownerId": "string",
      "postsCount": 1,
      "membersCount": 1,
      "url": "string",
      "avatarUrls": {
        "thumb": "string",
        "original": "string"
      },
      "createdAt": "2026-04-02T00:00:00.000Z",
      "isMember": true,
      "subdomain": "string",
      "country": "string"
    }
  ]
}

Loading...