/invite

Retrieves information of a given invite or invite list

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)

• invite - invite code to be fetched [String] (Optional)

If no invite was specified, it will grab all data and retrieve an Array, otherwise it will grab the one specified and retrieve an Object.

This will affect how to grab your data!

Examples:

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

Bot Designer for Discord

Example usage of /guild/invite endpoint using BDFD

$httpAddHeader[apikey;<YOUR-API-KEY>]
$httpAddHeader[bot-token;<YOUR-BOT-TOKEN>]
$httpAddHeader[guild-id;1064098700307218463] 
$httpAddHeader[invite;9s65BZDrbV] $c[Optional header]
$httpGet[https://bdfddata.rickyjs.xyz/<version>/guild/invite]


$httpResult OR $httpResult[details]

Discord.js

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

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

Possible Responses (Codes)

Code 200

API succeeded and details were fetched.

{
  status: 200,
  details: [
  {
      code: '8ZCcAbXq',
      type: 0,
      expires_at: 1681887486,
      guild: {
        id: '1064098700307218463',
        name: 'BDFDData API Community Support',
   >  'Read on `Invite Objects` : https://discord.com/developers/docs/resources/invite#invite-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)
}