/rolememberlist

This endpoint supports the Exclude header

Endpoint Headers:

  • bot-token - Token of the Bot [String] (Required)

  • apikey - Your Api Auth Key [String] (Required)

  • guild-id - ID of the guild to be fetched [Snowflake] (Required)

  • role-id - ID of the role to be fetched [Snowflake] (Required)

Endpoint URL Parameters

  • simple - Retrieves a simpler set of data [Boolean] (Optional)

Examples:

Data API version required. Must replace <version> with either release or beta.

Bot Designer for Discord

Example usage of /guild/rolememberlist endpoint using BDFD

$httpAddHeader[apikey;<YOUR-API-KEY>]
$httpAddHeader[bot-token;<YOUR-BOT-TOKEN>]
$httpAddHeader[guild-id;1064098700307218463] 
$httpAddHeader[role-id;1064098700307218463]
$httpGet[https://bdfddata.rickyjs.xyz/<version>/guild/rolememberlist]


$httpResult OR $httpResult[details]

OR

$httpAddHeader[apikey;<YOUR-API-KEY>]
$httpAddHeader[bot-token;<YOUR-BOT-TOKEN>]
$httpAddHeader[guild-id;1064098700307218463] 
$httpAddHeader[role-id;1064098700307218463]
$httpGet[https://bdfddata.rickyjs.xyz/<version>/guild/rolememberlist?simple=true]


$httpResult OR $httpResult[details]
Discord.js

Example usage of /guild/rolememberlist endpoint using Discord.js

const axios = require('axios');
(async () => {
return await axios.get('https://bdfddata.rickyjs.xyz/<version>/guild/rolememberlist', {
headers: {
"apikey": "<YOUR-API-KEY>",
"bot-token": "<YOUR-BOT-TOKEN>",
"guild-id": "1064098700307218463",
"role-id": "1076739010849947748"
}
}).then(res=>res.data)
})()

OR

const axios = require('axios');
(async () => {
return await axios.get('https://bdfddata.rickyjs.xyz/<version>/guild/rolememberlist?simple=true', {
headers: {
"apikey": "<YOUR-API-KEY>",
"bot-token": "<YOUR-BOT-TOKEN>",
"guild-id": "1064098700307218463"
"role-id": "1076739010849947748"
}
}).then(res=>res.data)
})()

Possible Responses (Codes)

Code 200 (Simple Not Used)

API succeeded and details were fetched.

{
  status: 200,
  details: [{
        "avatar": null,
        "banner": null,
        "communication_disabled_until": null,
        "flags": 0,
        "joined_at": "1745424337",
        "nick": null,
        "pending": false,
        "premium_since": null,
        "roles": ["1064410587293028413"],
        "unusual_dm_activity_until": null,
        "user": {
            "id": "123",
            "username": "user123",
            },
        "mute": false,
        "deaf": false
    }
  ]
  //gives array of full member objects
}
Code 200 (Simple Used)

API succeeded and details were fetched.

{
status: 200,
 "details": {
      "members": [{
            "id": "123",
            "username": "user123"
        }, {
            "id": "456",
            "username": "user456"
        }, {
            "id": "789",
            "username": "user789"
        }]
    }
Code 400

An error occurred that stopped execution.

{
    status: 400
    error: 'Cannot read ...  (This can vary)'
}
Code 401

Invalid bot token was provided.

{
  status: 401,
  details: { message: '401: Unauthorized', code: 0 }
}
Code 404

Guild was not found via DAPI

{
  status: 404,
  details: { message: 'Unknown Guild', code: 10004 } (this can vary)
}

Last updated