REST API v1 · Developers · API reference

Invites & Rewards API reference

All 3 Invites & Rewards endpoints of the BotGG REST API v1: scopes, parameters, fields, errors and ready-to-run curl, JavaScript and Python examples.

Developer docs
On this page

Endpoints

Paths are relative to https://console.botgg.app/api/v1. Send your API key as Authorization: Bearer botgg_…; IDs are strings.

Invites & Rewards endpoints
EndpointScopeDescription
GET/guilds/{guildId}/invites/members/{userId}invites:readGet a member’s invites
GET/guilds/{guildId}/invites/leaderboardinvites:readInvites leaderboard
POST/guilds/{guildId}/invites/members/{userId}/bonusinvites:writeAdd or remove bonus invites

Besides its own errors below, every endpoint can return these common ones:

Get a member’s invites

GET/guilds/{guildId}/invites/members/{userId}

Scope: invites:read

Invite counters, all-time rank and the active season’s count and rank. Members who invited nobody get zeros.

Needs this feature enabled on the server: Invites & Rewards

Parameters
NameInTypeRequiredDescription
guildIdpathstringYesYour server’s ID · Discord ID (string)
userIdpathstringYesThe member’s Discord user ID · Discord ID (string)

Response

Response fields · 200
FieldTypeRequiredDescription
userIdstringYes
invitesintegerYesverified + bonus (never below 0) — what milestones and the leaderboard use
verifiedintegerYes
pendingintegerYes
leftintegerYes
fakeintegerYes
bonusintegerYes
totalintegerYes
rankinteger | nullYes
seasonobject | nullYesThe active season, if any
season.idintegerYes
season.numberintegerYes
season.namestring | nullYes
season.startsAtstring | nullYes
season.endsAtstring | nullYes
season.invitesintegerYes
season.rankinteger | nullYes
Response · 200
{
  "userId": "876543210987654321",
  "invites": 10,
  "verified": 10,
  "pending": 10,
  "left": 10,
  "fake": 10,
  "bonus": 10,
  "total": 10,
  "rank": 1,
  "season": {
    "id": 98765,
    "number": 7,
    "name": "Example",
    "startsAt": "2026-10-07T12:00:00.000Z",
    "endsAt": "2026-10-07T12:00:00.000Z",
    "invites": 10,
    "rank": 1
  }
}

Examples

curl
curl -s "https://console.botgg.app/api/v1/guilds/123456789012345678/invites/members/876543210987654321" \
  -H "Authorization: Bearer $BOTGG_API_KEY"
JavaScript (fetch)
// Node.js 18+ (built-in fetch) — on your server, never in a browser
const res = await fetch('https://console.botgg.app/api/v1/guilds/123456789012345678/invites/members/876543210987654321', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.BOTGG_API_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.error}: ${data.message}`);
console.log(data);
Python (requests)
import os
import requests

res = requests.get(
    "https://console.botgg.app/api/v1/guilds/123456789012345678/invites/members/876543210987654321",
    headers={
        "Authorization": f"Bearer {os.environ['BOTGG_API_KEY']}",
    },
    timeout=10,
)
data = res.json()
if not res.ok:
    raise RuntimeError(f"{res.status_code} {data['error']}: {data['message']}")
print(data)

Errors

Invites leaderboard

GET/guilds/{guildId}/invites/leaderboard

Scope: invites:read

period=all ranks by invites (verified + bonus), period=season by the active season’s invites (empty without a season). Pass cursor=<nextCursor> for the next page.

Needs this feature enabled on the server: Invites & Rewards

Parameters
NameInTypeRequiredDescription
guildIdpathstringYesYour server’s ID · Discord ID (string)
periodquerystringNoOne of all, season · Default "all"
limitqueryintegerNo1–100 · Default 25
cursorqueryintegerNo0–10,000,000 · Default 0

Response

Response fields · 200
FieldTypeRequiredDescription
periodstringYesOne of all, season
seasonobject | nullYes
season.idintegerYes
season.numberintegerYes
season.namestring | nullYes
season.startsAtstring | nullYes
season.endsAtstring | nullYes
itemsarray of objectYes
items[].rankintegerYes
items[].userIdstringYes
items[].scoreintegerYes
items[].invitesintegerYes
items[].verifiedintegerYes
items[].bonusintegerYes
totalintegerYes
nextCursorstring | nullYes
Response · 200
{
  "period": "all",
  "season": {
    "id": 98765,
    "number": 7,
    "name": "Example",
    "startsAt": "2026-10-07T12:00:00.000Z",
    "endsAt": "2026-10-07T12:00:00.000Z"
  },
  "items": [
    {
      "rank": 1,
      "userId": "876543210987654321",
      "score": 10,
      "invites": 10,
      "verified": 10,
      "bonus": 10
    }
  ],
  "total": 10,
  "nextCursor": "98700"
}

Examples

curl
curl -s "https://console.botgg.app/api/v1/guilds/123456789012345678/invites/leaderboard?period=all&limit=25&cursor=0" \
  -H "Authorization: Bearer $BOTGG_API_KEY"
JavaScript (fetch)
// Node.js 18+ (built-in fetch) — on your server, never in a browser
const res = await fetch('https://console.botgg.app/api/v1/guilds/123456789012345678/invites/leaderboard?period=all&limit=25&cursor=0', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.BOTGG_API_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.error}: ${data.message}`);
console.log(data);
Python (requests)
import os
import requests

res = requests.get(
    "https://console.botgg.app/api/v1/guilds/123456789012345678/invites/leaderboard",
    headers={
        "Authorization": f"Bearer {os.environ['BOTGG_API_KEY']}",
    },
    params={
        "period": "all",
        "limit": 25,
        "cursor": 0,
    },
    timeout=10,
)
data = res.json()
if not res.ok:
    raise RuntimeError(f"{res.status_code} {data['error']}: {data['message']}")
print(data)

Errors

Add or remove bonus invites

POST/guilds/{guildId}/invites/members/{userId}/bonus

Scope: invites:writeIdempotency-Key

Same as /invites add|remove. Counts toward the active season; milestone rewards for additions are granted by the bot within a minute. Written to the audit log.

Needs this feature enabled on the server: Invites & Rewards

Parameters
NameInTypeRequiredDescription
guildIdpathstringYesYour server’s ID · Discord ID (string)
userIdpathstringYesThe member’s Discord user ID · Discord ID (string)
Idempotency-KeyheaderstringNoOptional. Send a unique value (a UUID) and reuse it when you retry: the change happens only once. How it works

Request body

Request body
FieldTypeRequiredDescription
amountintegerYesPositive = add bonus invites, negative = remove
-100,000–100,000
reasonstring | nullNoShown in the audit log
up to 200 characters

Response

Response fields · 201
FieldTypeRequiredDescription
userIdstringYes
amountintegerYes
previousBonusintegerYes
bonusintegerYes
invitesintegerYes
verifiedintegerYes
Response · 201
{
  "userId": "876543210987654321",
  "amount": 100,
  "previousBonus": 10,
  "bonus": 10,
  "invites": 10,
  "verified": 10
}

Examples

curl
curl -s -X POST "https://console.botgg.app/api/v1/guilds/123456789012345678/invites/members/876543210987654321/bonus" \
  -H "Authorization: Bearer $BOTGG_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"amount":100,"reason":"Tournament prize"}'
JavaScript (fetch)
// Node.js 18+ (built-in fetch) — on your server, never in a browser
const res = await fetch('https://console.botgg.app/api/v1/guilds/123456789012345678/invites/members/876543210987654321/bonus', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.BOTGG_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(), // reuse it when you retry this request
  },
  body: JSON.stringify({
    amount: 100,
    reason: 'Tournament prize',
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.error}: ${data.message}`);
console.log(data);
Python (requests)
import os, uuid
import requests

res = requests.post(
    "https://console.botgg.app/api/v1/guilds/123456789012345678/invites/members/876543210987654321/bonus",
    headers={
        "Authorization": f"Bearer {os.environ['BOTGG_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),  # reuse it when you retry this request
    },
    json={
        "amount": 100,
        "reason": "Tournament prize",
    },
    timeout=10,
)
data = res.json()
if not res.ok:
    raise RuntimeError(f"{res.status_code} {data['error']}: {data['message']}")
print(data)

Errors

Ready to level up your server?

Add BotGG for free, then switch features on in the web console.