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 users followed by user

Retrieve a paginated list of users that the specified user follows. Includes follow relationship to the viewer if authenticated.

Path Parameters

id string required

UUID of the user

Query Parameters

limit number

Possible values: >= 1 and <= 20

Default value: 20

Results per page (default: 10)

page number

Possible values: >= 1

Default value: 1

Page number (default: 1)

Responses

• 200
• 404

---

List of followed users with pagination

application/json

Schema

Example (from schema)

Example

---

Schema

total number required
currentPage number required
limit number required
pages number required
data object[] required
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
followed boolean
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
]

{
  "total": 10,
  "currentPage": 1,
  "limit": 10,
  "pages": 1,
  "data": [
    {
      "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,
      "followed": false,
      "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"
    }
  ]
}

{
  "total": 10,
  "currentPage": 1,
  "limit": 10,
  "pages": 1,
  "data": [
    {
      "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,
      "followed": false,
      "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"
    }
  ]
}

User not found

Loading...