Skip to main content
POST
/
guilds
/
{guild_id}
/
members-search
Search guild members
curl --request POST \
  --url https://api.fluxer.app/v1/guilds/{guild_id}/members-search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "limit": 50,
  "offset": 4503599627370495,
  "role_ids": [
    "<string>"
  ],
  "joined_at_gte": 123,
  "joined_at_lte": 123,
  "join_source_type": [
    123
  ],
  "source_invite_code": [
    "<string>"
  ],
  "is_bot": true,
  "user_created_at_gte": 123,
  "user_created_at_lte": 123,
  "sort_by": "joinedAt",
  "sort_order": "asc"
}
'
{
  "guild_id": "<string>",
  "members": [
    {
      "id": "<string>",
      "guild_id": "<string>",
      "user_id": "<string>",
      "username": "<string>",
      "discriminator": "<string>",
      "global_name": "<string>",
      "nickname": "<string>",
      "role_ids": [
        "<string>"
      ],
      "joined_at": 123,
      "supplemental": {
        "source_invite_code": "<string>",
        "inviter_id": "<string>",
        "join_source_type": 0
      },
      "is_bot": true
    }
  ],
  "page_result_count": 123,
  "total_result_count": 123,
  "indexing": true
}

Authorizations

​
Authorization
string
header
required

Bot token: Authorization: Bot <token>. This is the primary authentication method for bot applications.

Path Parameters

​
guild_id
string<snowflake>
required

The ID of the guild

Body

application/json
​
query
string

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

Maximum string length: 100
​
limit
integer<int32>

Maximum number of results to return

Required range: 1 <= x <= 100
​
offset
integer<int64>

Number of results to skip for pagination

Required range: 0 <= x <= 9007199254740991
​
role_ids
string[]

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

Maximum array length: 10
​
joined_at_gte
integer<int53>

Filter members who joined at or after this unix timestamp

​
joined_at_lte
integer<int53>

Filter members who joined at or before this unix timestamp

​
join_source_type
integer<int53>[]

Filter by join source types

Maximum array length: 10
​
source_invite_code
string[]

Filter by invite codes used to join

Maximum array length: 10
​
is_bot
boolean

Filter by bot status

​
user_created_at_gte
integer<int53>

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

​
user_created_at_lte
integer<int53>

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

​
sort_by
enum<string>

Sort results by field

Available options:
joinedAt,
relevance
​
sort_order
enum<string>

Sort order

Available options:
asc,
desc

Response

Success

​
guild_id
string
required

Guild ID

​
members
object[]
required

Matching members

​
page_result_count
integer<int53>
required

Number of results in this page

​
total_result_count
integer<int53>
required

Total number of matching results

​
indexing
boolean
required

Whether the guild members are currently being indexed