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 profile by URL or subdomain

Retrieve a room profile by its unique URL (for groups) or subdomain (for pages). Returns room details, member counts, and relationship status.

Path Parameters

url string

Group URL identifier (lowercase)

subdomain string

Page subdomain identifier (lowercase)

Responses

• 200
• 404

---

Room profile with details and membership info

application/json

Schema

Example (from schema)

Example

---

Schema

privateToken string
mutualFollowers object[]
Array [
avatarUrls object required
settings object
ayahLanguages number[]
reflectionLanguages number[]
customized boolean
hideFollowSuggestion boolean
Hide follow suggestion popup after liking a post
showFollowFeaturedSuggestion boolean
Show featured follow suggestion popup on Quran Reflect onboarding
createdAt string required
joiningYear number required
username string
id string required
verified boolean
Default value: false
postAs boolean
Default value: false
firstName string
lastName string
postsCount number
Default value: 0
languageId number
followersCount number
Default value: 0
likesCount number
Default value: 0
isAdmin boolean
Default value: false
languageIsoCode string
Default value: en
bio string
country string
followed boolean
]
mutualFollowersCount number
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

{
  "privateToken": "private-room-token",
  "mutualFollowers": [
    {
      "avatarUrls": {
        "small": "https://avatars.githubusercontent.com/u/12345678",
        "medium": "https://avatars.githubusercontent.com/u/12345678",
        "large": "https://avatars.githubusercontent.com/u/12345678"
      },
      "settings": {
        "ayahLanguages": [
          0
        ],
        "reflectionLanguages": [
          0
        ],
        "customized": true,
        "hideFollowSuggestion": true,
        "showFollowFeaturedSuggestion": true
      },
      "createdAt": "2000-01-21 00:00:00",
      "joiningYear": 2025,
      "username": "string",
      "id": "string",
      "verified": false,
      "postAs": false,
      "firstName": "string",
      "lastName": "string",
      "postsCount": 0,
      "languageId": 0,
      "followersCount": 0,
      "likesCount": 0,
      "isAdmin": false,
      "languageIsoCode": "en",
      "bio": "string",
      "country": "string",
      "followed": true
    }
  ],
  "mutualFollowersCount": 2,
  "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.473Z",
  "isMember": true,
  "subdomain": "string",
  "country": "string"
}

{
  "privateToken": "private-room-token",
  "mutualFollowers": [
    {
      "avatarUrls": {
        "small": "https://avatars.githubusercontent.com/u/12345678",
        "medium": "https://avatars.githubusercontent.com/u/12345678",
        "large": "https://avatars.githubusercontent.com/u/12345678"
      },
      "settings": {
        "ayahLanguages": [
          1
        ],
        "reflectionLanguages": [
          1
        ],
        "customized": true,
        "hideFollowSuggestion": true,
        "showFollowFeaturedSuggestion": true
      },
      "createdAt": "2000-01-21 00:00:00",
      "joiningYear": 2025,
      "username": "string",
      "id": "string",
      "verified": false,
      "postAs": false,
      "firstName": "string",
      "lastName": "string",
      "postsCount": 0,
      "languageId": 1,
      "followersCount": 0,
      "likesCount": 0,
      "isAdmin": false,
      "languageIsoCode": "en",
      "bio": "string",
      "country": "string",
      "followed": true
    }
  ],
  "mutualFollowersCount": 2,
  "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"
}

Room not found

Loading...