members_search
members_search
Section titled “members_search”Category: members
Fuzzy-search guild members by username/nick prefix.
When to use
Section titled “When to use”convert “find @alice” or “users named bob” into snowflake IDs.
When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild to search |
query | string | yes | Username/nick prefix or substring |
limit | integer | yes | Max matches (1-1000, default 25) |
Returns
Section titled “Returns”\{matches:[\{user_id, username, global_name, nick\}], count\}.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
matches | array | yes | |
count | number | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | yes |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |