List mention candidates

GET/chat-rooms/:id/mention-candidates

List the people who can be @mentioned. Only users returned here are accepted in the mentions field when sending a message (the server applies the same check). For community chats the set is the approved community members, which differs from the members endpoint (ChatRoomMember rows). Event chats do not support mentions and always return an empty array. There is no pagination: results are capped by limit, so narrow them with q.

AuthLogin required

Path parameters

idstringrequired

Chat room ID.

Query parameters

qstring

Partial match on name or slug. Space-separated terms are ANDed.

limitnumber

Maximum number of results. Defaults to 20, capped at 50. Results are truncated at the cap; narrow them with q instead of paging.

Response

FieldTypeDescription
usersUser[]Array of users who can be mentioned.
Request
curl https://api.4s.link/chat-rooms/ID/mention-candidates \
-H "Authorization: Bearer 4s_at_..."
Example response
{
"users": [
{ "id": "a1b2c3d4-...", "slug": "taro", "firstName": "太郎", "lastName": "山田", "nativeName": "山田太郎", "avatarUrl": "https://.../avatar.png" }
]
}