Classic APIs
ClassicGamesApi
vipServerInfo

vipServerInfo

Gets information about a particular vip server.

Parameters

NameTypeDescription
vipServerIdVipServerIdThe ID of the vip server to get info for.

Example

const { data: serverInfo } = await ClassicGamesApi.vipServerInfo({ vipServerId: 1630945839 });

Example Data

{
  id: 1630945839,
  name: "Testing",
  game: {
    id: 6430220996,
    name: "Get Id",
    rootPlace: { id: 18980972074, name: "Get Id" },
  },
  joinCode: "70420354791950165689950670608627",
  active: true,
  subscription: {
    active: false,
    expired: false,
    expirationDate: "2024-09-17T15:49:02.8879762Z",
    price: null,
    canRenew: false,
    hasInsufficientFunds: false,
    hasRecurringProfile: true,
    hasPriceChanged: true,
  },
  permissions: {
    clanAllowed: false,
    enemyClanId: null,
    friendsAllowed: false,
    users: [],
  },
  voiceSettings: { enabled: false },
  link: "https://www.roblox.com/games/18980972074?privateServerLinkCode=70420354791950165689950670608627",
}

Endpoint

GET /v1/vip-servers/{vipServerId}
authedUserCanUserBeInvitedToVipServerupdateVipServer