Fetch User Suggestions

Get user suggestions for mentions and user pickers

GET /:projectId/users/suggestions

Fetch User Suggestions

cURL

curl --request GET \
  --url https://api.replyke.com/api/v6/:projectId/users/suggestions

200

{
  "[].id": "<string>",
  "[].username": "<string>",
  "[].name": "<string>",
  "[].avatar": "<string>"
}

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

Missing or Invalid Query Parameter - 400 Bad Request

{
  "error": "Missing or invalid query parameter",
  "code": "user/invalid-query"
}

Server Error - 500 Internal Server Error

{
  "error": "Internal server error",
  "code": "user/server-error",
  "details": "<Error message>"
}

---

Notes

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