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.

Get joined or managed rooms

Retrieve rooms the user has joined (joined-rooms) or manages as admin (managed-rooms). Supports search and pagination.

Query Parameters

query string

Search query for room names

page number

Possible values: >= 1

Default value: 1

Page number (default: 1)

limit number

Possible values: >= 1 and <= 5

Default value: 5

Rooms per page (default: 5)

sortBy string

Possible values: [NAME_ASC, NAME_DESC, LATEST_ACTIVITY]

Sort order (default: NAME_ASC)

Responses

• 200
• 401

---

Rooms retrieved 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 [
isPublic boolean deprecated
Deprecated content-visibility projection. Use privacy instead.
id number required
name string required
description string required
roomType string required
isActive boolean required
isVerified boolean required
privacy string required
Possible values: [public, closed, private]
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
membershipRequestStatus string
Possible values: [none, pending]
pendingMembershipRequestsCount number
]

{
  "total": 10,
  "currentPage": 1,
  "limit": 10,
  "pages": 1,
  "data": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "roomType": "string",
      "isActive": true,
      "isVerified": true,
      "privacy": "public",
      "hideFollowJoinButton": true,
      "isOwner": true,
      "isAdmin": true,
      "ownerId": "string",
      "postsCount": 0,
      "membersCount": 0,
      "url": "string",
      "avatarUrls": {
        "thumb": "string",
        "original": "string"
      },
      "createdAt": "2026-10-06T17:14:54.723Z",
      "isMember": true,
      "subdomain": "string",
      "country": "string",
      "membershipRequestStatus": "none",
      "pendingMembershipRequestsCount": 0
    }
  ]
}

{
  "total": 10,
  "currentPage": 1,
  "limit": 10,
  "pages": 1,
  "data": [
    {
      "isPublic": true,
      "id": 1,
      "name": "string",
      "description": "string",
      "roomType": "string",
      "isActive": true,
      "isVerified": true,
      "privacy": "public",
      "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",
      "membershipRequestStatus": "none",
      "pendingMembershipRequestsCount": 1
    }
  ]
}

User not authenticated

Loading...