# Guild

Shows information about the currently authenticated group.

# 🔐 Route

This is an authenticated route.
It requires an auth header:

authentication: The bearer token contained in your authentication string
Example: Soldier HCYrY1MsaB2fd13

# Endpoints

# Get Guild Info

Shows information and settings about the authenticated guild.

Request Body
No Request Body required for this request

Response

Code

Body

  {
    success: true,
    status: "OK",
    data: Guild
  }

# Types

# Guild Object

Guild
{
  guildId: snowflake;
  accountId: number;
  groupId: number;
  premium: boolean;

  rank: {
    ranklocks: Ranklock;
    request: RankRequest;
  },

  xp: {
    enabled: boolean;
    ranklocks: Ranklock;
    xpRanks: XpRank;
  }
}

# Ranklock Object

Ranklock
{
  rank: number.int();
  type: "Normal" | "SectionUp" | "SectionDown";
}

# XpRank Object

XpRank
{
  incrementXp: number.int();
  totalXp: number.int();
  rank: number.int();
}

# RankRequest Object

RankRequest
{
  rankerId: number.int();
  toRankId: number.int();
  rank: number.int();
  reason: string?;
  result: "Promotion" | "Demotion";
  type: "Normal" | "Xp" | "Join";
}