Search for users

Search for users

Query Parameters

query string required
limit number required
page number required
all boolean required
postingAs boolean required
postingAsUserId string required
roomId number required

Responses

• 200

---

Users retrieved successfully

application/json

Schema

Example (from schema)

---

Schema

total number required
currentPage number required
limit number required
pages number required
data object[] required
Array [
avatarUrls object required
createdAt object required
joiningYear number required
isPasswordSet boolean
settings object required
ayahLanguages number[]
reflectionLanguages number[]
username string
id string required
verified boolean
Default value: false
postAs boolean
Default value: false
firstName string
lastName string
postsCount number
Default value: 0
averageToxicity number
Default value: 0
languageId number
banned boolean
Default value: false
memberType 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
]

{
  "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"
      },
      "createdAt": "2000-01-21 00:00:00",
      "joiningYear": 2025,
      "isPasswordSet": true,
      "settings": {
        "ayahLanguages": [
          0
        ],
        "reflectionLanguages": [
          0
        ]
      },
      "username": "string",
      "id": "string",
      "verified": false,
      "postAs": false,
      "firstName": "string",
      "lastName": "string",
      "postsCount": 0,
      "averageToxicity": 0,
      "languageId": 0,
      "banned": false,
      "memberType": 0,
      "followersCount": 0,
      "likesCount": 0,
      "isAdmin": false,
      "languageIsoCode": "en",
      "bio": "string",
      "country": "string",
      "followed": true
    }
  ]
}

Loading...