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 user profile​

Retrieve the complete profile of the authenticated user including personal info, settings, statistics, and connected accounts.

Query Parameters
    qdc boolean

    Include Quran.com (QDC) connected account data

Responses

Full user profile with all data

Schema
    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

    Only returned when qdc=true and the Quran.com connected account lookup succeeds.

    email string

    Only returned when qdc=true and the Quran.com connected account lookup succeeds.

    photoUrl string

    Only returned when qdc=true and the Quran.com connected account lookup succeeds.

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