Skip to main content
GET
Fetch User Suggestions
Fetch a list of up to 5 suggested users based on a query string. Useful for mention systems or user pickers.

Query Parameters

query
string
required
The input string used to search usernames. Usernames starting with this query are ranked higher.

Response

Returns an array of user objects (maximum 5 results)
[].id
string
User’s unique identifier
[].username
string
User’s username
[].name
string
User’s full name
[].avatar
string
URL to user’s avatar image

Error Responses


Notes

  • Maximum of 5 results are returned.
  • Usernames starting with the query are ranked higher.
  • Returned user objects exclude sensitive fields (email, hash, etc.).