Skip to main content

User-related API environment

Production user-related API docs

These pages describe the Production user-related API stack.

Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.

Need to test before going live? Switch to the Pre-live docs using the environment switcher above.

Get room profile by ID​

Retrieve a room profile by its unique numeric ID. Returns room details, member counts, and relationship status for the current user.

Path Parameters
    id number required

    Unique numeric room ID

Responses

Room profile retrieved successfully

Schema
    isPublic boolean deprecated

    Deprecated content-visibility projection. Use privacy instead.

    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
    isPasswordSet boolean
    username string
    id string required
    verified boolean

    Default value: false

    postAs boolean

    Default value: false

    firstName string
    lastName string
    fullName 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

    updateSource string
    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
    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
Loading...