Skip to main content
GET
/
:projectId
/
users
/
suggestions
Fetch User Suggestions
curl --request GET \
  --url https://api.replyke.com/api/v6/:projectId/users/suggestions
{
  "[].id": "<string>",
  "[].username": "<string>",
  "[].name": "<string>",
  "[].avatar": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.replyke.com/llms.txt

Use this file to discover all available pages before exploring further.

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

{
  "error": "Missing or invalid query parameter",
  "code": "user/invalid-query"
}
{
  "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.).