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 by id or username

Retrieve a user profile by either UUID or username. If viewing your own profile, returns full data; otherwise returns public profile with follow relationship status.

Path Parameters

id uuid

UUID of the user

username string

Username of the user (case-insensitive)

Query Parameters

qdc boolean

Include Quran.com connected account data

Responses

• 200
• 404

---

Own profile with full data, or another user public profile with mutual followers info

application/json

Schema

Example (from schema)

Example

---

Schema

oneOf
UserProfileResponseDto
OtherUserProfileDto
---
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
featuredAuthorsDismissedAt string
Featured authors block dismissal timestamp
featuredAuthorIdsAtDismissal string[]
Featured author IDs visible when the block was dismissed
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
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
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
featuredAuthorsDismissedAt string
Featured authors block dismissal timestamp
featuredAuthorIdsAtDismissal string[]
Featured author IDs visible when the block was dismissed
createdAt string required
joiningYear number required
followed boolean
Whether the authenticated viewer follows this user.
mutualFollowers object[]
Only returned when the viewer is authenticated.
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
featuredAuthorsDismissedAt string
Featured authors block dismissal timestamp
featuredAuthorIdsAtDismissal string[]
Featured author IDs visible when the block was dismissed
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
Only returned when the viewer is authenticated.
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

{}

{
  "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,
    "featuredAuthorsDismissedAt": "string",
    "featuredAuthorIdsAtDismissal": [
      "string"
    ]
  },
  "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",
  "fullName": "string",
  "postsCount": 0,
  "languageId": 1,
  "followersCount": 0,
  "likesCount": 0,
  "isAdmin": false,
  "languageIsoCode": "en",
  "updateSource": "string",
  "bio": "string",
  "country": "string",
  "followed": true
}

User not found

Loading...