/users

List the users interested in the specified event

This endpoint requires a POST request!

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)

Endpoint Body Parameters

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

• limit - number of users to return (up to maximum 100) [Integer] (Optional)

• with_member - include guild member data if it exists [Boolean] (Optional)

• before -consider only users before given user id [Snowflake] (Optional)

• after - consider only users before given user id [Snowflake] (Optional)

Examples:

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

Bot Designer for Discord

Example usage of /guild/event/users endpoint using BDFD

$httpAddHeader[apikey;<YOUR-API-KEY>]
$httpAddHeader[bot-token;<YOUR-BOT-TOKEN>]
$httpAddHeader[guild-id;1064098700307218463] 
$httpPost[https://bdfddata.rickyjs.xyz/<version>/guild/event/users;{
 "event": "1012409860407918463"
 }]


$httpResult OR $httpResult[details]

Discord.js

Example usage of /guild/event/users endpoint using Discord.js

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

Possible Responses (Codes)

Code 200

API succeeded and details were fetched.

{
 status: 200
 {
  status: 200,
  details: [ 
    {
      user: {
        id: '672215920558604332',
        username: 'Rickყ',
        global_name: null,
        display_name: null,
        avatar: 'https://cdn.discordapp.com/avatars/672215920558604332/99585a23004b9e5592b3842e24636ae3.jpg',

   >  'Read on `Event User Objects`: https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-user-object' 
  }]
} 

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)
}