Guilds

Search guild members

Search and filter guild members with pagination support.

post/guilds/{guild_id}/members-search

Path parameters

string snowflake required
OR
integer required

The ID of the guild

Request body

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_typeJoinSourceTypeInput[]

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

Response

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

Changes

Changed in 4 of the 21 revisions of this API.43228

  • dd0ad4ea1c8844See the full diff
    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /// became nullable for the status

      response-property-became-nullable

    • ○

      response property members/items/global_name list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property members/items/nickname list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property members/items/supplemental/inviter_id list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property members/items/supplemental/source_invite_code list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 21 revisions, 2 have no diff computed.