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 room members

Retrieve paginated list of members in a room (group or page). Returns user profiles with their roles.

Path Parameters

id number required

Unique numeric room ID

Query Parameters

limit number

Members per page (default: 10)

page number

Page number (default: 1)

Responses

• 200
• 404

---

Room members 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 [
id string required
username string required
firstName string required
lastName string required
verified boolean required
avatarUrls object required
isAdmin boolean required
isOwner boolean required
isFollowed boolean required
isActive boolean required
followersCount number required
]

{
  "total": 10,
  "currentPage": 1,
  "limit": 10,
  "pages": 1,
  "data": [
    {
      "id": "user-1",
      "username": "member.username",
      "firstName": "Member",
      "lastName": "User",
      "verified": true,
      "avatarUrls": {
        "small": "https://avatars.quran.foundation/users/user-1/small.png",
        "medium": "https://avatars.quran.foundation/users/user-1/medium.png",
        "large": "https://avatars.quran.foundation/users/user-1/large.png"
      },
      "isAdmin": false,
      "isOwner": false,
      "isFollowed": true,
      "isActive": true,
      "followersCount": 42
    }
  ]
}

{
  "total": 10,
  "currentPage": 1,
  "limit": 10,
  "pages": 1,
  "data": [
    {
      "id": "user-1",
      "username": "member.username",
      "firstName": "Member",
      "lastName": "User",
      "verified": true,
      "avatarUrls": {
        "small": "https://avatars.quran.foundation/users/user-1/small.png",
        "medium": "https://avatars.quran.foundation/users/user-1/medium.png",
        "large": "https://avatars.quran.foundation/users/user-1/large.png"
      },
      "isAdmin": false,
      "isOwner": false,
      "isFollowed": true,
      "isActive": true,
      "followersCount": 42
    }
  ]
}

Room not found

Loading...