$findUser

The $findUser[] function allows you to search for a user by their name, mention, or ID. It returns the Discord ID of the user found.

Syntax

$findUser[name/mention/ID]

Parameters

Parameter	Description
query	The search term: username (partial or full), raw mention (<@ID>), or numerical ID.

Return Value

• Type: Snowflake (numeric string) or empty string
• The ID of the corresponding user
• An empty string if no user is found

Behavior

• The search by name is case-insensitive.
• The search by name can be partial (e.g., "Jean" matches "JeanDupont").
• The search is performed among users known to the bot (shared servers cache).
• Priority of match: exact mention > exact ID > username > server nickname.

Examples

Search by command argument

$let[target;$findUser[$message]]
$if[$target!=]
  $title[User Found]
  $description[
  **ID:** $target
  **Name:** $userName[$target]
  ]
  $thumbnail[$userAvatar[$target]]
  $color[#5865F2]
  $sendMessage[]
$else
  $sendMessage[No user found for "$message".]
$endif

Search and action

$let[target;$findUser[$message[1]]]
$if[$target!=]
  $if[$checkContains[$userPerms;KickMembers]==true]
    $kick[$target]
    $sendMessage[$userName[$target] was kicked.]
  $endif
$else
  $sendMessage[User not found.]
$endif

Search with fallback

$let[target;$findUser[$message]]
$if[$target!=]
  $sendMessage[User: $userName[$target]]
$else
  $sendMessage[User not found. Defaulting to the author.]
  $let[target;$authorID]
$endif

Notes

• $findUser[] is more flexible than $mentioned because it accepts partial names.
• Always check the result (making sure it is not empty) before using the returned ID.
• Useful for commands where the user can provide a name, an ID, or a mention.
• The search is limited to users that the bot “knows” (present in shared servers).