Guilds

Search guild members

Changed on

Search and filter guild members with pagination support.

post/guilds/{guild_id}/members-search

Request

  • Base URL: https://web.fluxer.app/api/v1
  • URL: https://web.fluxer.app/api/v1/guilds/{guild_id}/members-search
  • Auth: one of:
    • API key in header Authorization
    • API key in header Authorization

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

  • dd0ad4ea1c88Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • info

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

    • info

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

    • info

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

    • info

      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

  • a52a2cf49d9bRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    This list may be incomplete.