Guilds

Search guild members

Search and filter guild members with pagination support.

post/guilds/{guild_id}/members-search

Path parameters

guild_idstring snowflake required

The ID of the guild

querystring

Text to search for in usernames, global names, and nicknames

limitinteger

Maximum number of results to return

offsetinteger

Number of results to skip for pagination

role_idsstring[]

Filter by role IDs (member must have all specified roles)

joined_at_gteinteger

Filter members who joined at or after this unix timestamp

joined_at_lteinteger

Filter members who joined at or before this unix timestamp

join_source_typeJoinSourceType[]

Filter by join source types

source_invite_codestring[]

Filter by invite codes used to join

is_botboolean

Filter by bot status

user_created_at_gteinteger

Filter members whose account was created at or after this unix timestamp

user_created_at_lteinteger

Filter members whose account was created at or before this unix timestamp

sort_by'joinedAt' | 'relevance'

Sort results by field

sort_order'asc' | 'desc'

Sort order

Success

guild_idstring required

Guild ID

page_result_countinteger required

Number of results in this page

total_result_countinteger required

Total number of matching results

indexingboolean required

Whether the guild members are currently being indexed

No recorded changes to this endpoint across all 1 revision of this API.