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.

Search for users

Search by name or username requires at least one non-whitespace character, accepts at most 100 characters including whitespace, and is limited to pages 1–10 for every caller. Missing, empty, or whitespace-only queries return an empty result without searching. Guests see verified users only; authenticated users retain broader search for mentions, room invites, and discovery. A proxy cookie or client-supplied identity does not grant authenticated search.

Query Parameters

query string

Possible values: <= 100 characters

Optional search term for name/username; at least one non-whitespace character is required to search. Missing, empty, or whitespace-only queries return an empty result, and at most 100 characters including whitespace are accepted

limit number

Results per page (default: 10)

page number

Page number (default: 1; maximum: 10)

all boolean

Search all users (not just followed)

postingAs boolean

Filter for posting-as feature

postingAsUserId uuid

User ID for posting-as context

roomId number

Room ID for scoped search

Responses

• 200
• 400

---

Matching users with at most 10 accessible pages. A missing, empty, or whitespace-only query returns data: [], total: 0, and pages: 0. When roomId is provided, each result includes isMember.

application/json

Schema

Example (from schema)

Example

---

Schema

total number required
currentPage number required
limit number required
pages number required
data object[] required
Array [
id string required
username string
verified boolean
Default value: false
firstName string
lastName string
fullName string
avatarUrls object required
followersCount number
Default value: 0
isFollowed boolean required
followed boolean
isMember boolean
]

{
  "total": 10,
  "currentPage": 1,
  "limit": 10,
  "pages": 1,
  "data": [
    {
      "id": "8d77a633-b49d-4978-bc1a-70bc2fda7b4b",
      "username": "string",
      "verified": false,
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "avatarUrls": {
        "small": "https://avatars.githubusercontent.com/u/12345678"
      },
      "followersCount": 0,
      "isFollowed": false,
      "followed": false,
      "isMember": false
    }
  ]
}

{
  "total": 10,
  "currentPage": 1,
  "limit": 10,
  "pages": 1,
  "data": [
    {
      "id": "8d77a633-b49d-4978-bc1a-70bc2fda7b4b",
      "username": "string",
      "verified": false,
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "avatarUrls": {
        "small": "https://avatars.githubusercontent.com/u/12345678"
      },
      "followersCount": 0,
      "isFollowed": false,
      "followed": false,
      "isMember": false
    }
  ]
}

The search query is longer than 100 characters or is not a string, or the requested page is after 10.

Loading...