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

• 200
• 401

---

Full user profile with all data

application/json

Schema

Example (from schema)

Example

---

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

{
  "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,
  "isPasswordSet": true,
  "email": "[email protected]",
  "photoUrl": "https://photos.quran.com/img/user.jpg",
  "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
}

{
  "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,
  "isPasswordSet": true,
  "email": "[email protected]",
  "photoUrl": "https://photos.quran.com/img/user.jpg",
  "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
}

User not authenticated

Loading...