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 users by name or username. Supports mentioning in posts, finding users for room invites, and general discovery. Results can be scoped to specific contexts.

Query Parameters

query string

Search term for name/username

limit number

Results per page (default: 10)

page number

Page number (default: 1)

all boolean

Search all users (not just followed)

postingAs boolean

Filter for posting-as feature

postingAsUserId string

User ID for posting-as context

roomId number

Room ID for scoped search

Responses

• 200

---

Matching 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 [
id string required
username string
verified boolean
Default value: false
firstName string
lastName string
avatarUrls object required
followersCount number
Default value: 0
bio string
isFollowed boolean required
followed boolean
]

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

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

Loading...