---
title: "Fetch server information"
method: GET
path: "/v2/server"
---

# Fetch server information

`GET /v2/server`

Returns server status data. Additional fields can be included by setting query parameters to 'true'. All query parameters are optional.

## Query parameters

- `Players` boolean
- `Staff` boolean
- `JoinLogs` boolean
- `Queue` boolean
- `KillLogs` boolean
- `CommandLogs` boolean
- `ModCalls` boolean
- `EmergencyCalls` boolean
- `Vehicles` boolean

## Headers

- `Authorization` string

## Response `200`

Requested data. Optional fields only included when query=true.

- object
  - `Name` string, required
  - `OwnerId` integer, required
  - `CoOwnerIds` integer[], required
  - `CurrentPlayers` integer, required
  - `MaxPlayers` integer, required
  - `JoinKey` string, required
  - `AccVerifiedReq` string, required
  - `TeamBalance` boolean, required
  - `Players` object[] — Only included when Players=true query parameter is provided
    - `Team` string
    - `Player` string
    - `Callsign` string, nullable — Only available if the player is on a non-civilian team
    - `Location` object
      - `LocationX` number
      - `LocationZ` number
      - `PostalCode` string
      - `StreetName` string
      - `BuildingNumber` string
    - `Permission` string
    - `WantedStars` integer
  - `Staff` object — Only included when Staff=true query parameter is provided
    - `Admins` object — Map of Roblox user IDs (numeric string keys) to usernames for server administrators
    - `Mods` object — Map of Roblox user IDs (numeric string keys) to usernames for server moderators
    - `Helpers` object — Map of Roblox user IDs (numeric string keys) to usernames for server helpers
  - `JoinLogs` object[] — Only included when JoinLogs=true query parameter is provided
    - `Join` boolean
    - `Timestamp` integer
    - `Player` string
  - `Queue` integer[] — Only included when Queue=true query parameter is provided
  - `KillLogs` object[] — Only included when KillLogs=true query parameter is provided
    - `Killed` string
    - `Timestamp` integer
    - `Killer` string
  - `CommandLogs` object[] — Only included when CommandLogs=true query parameter is provided
    - `Player` string
    - `Timestamp` integer
    - `Command` string
  - `ModCalls` object[] — Only included when ModCalls=true query parameter is provided
    - `Caller` string
    - `Moderator` string, nullable
    - `Timestamp` integer
  - `EmergencyCalls` object[] — Only included when EmergencyCalls=true query parameter is provided
    - `Team` string
    - `Caller` integer
    - `Players` integer[]
    - `Position` number[]
    - `StartedAt` integer
    - `CallNumber` integer
    - `Description` string
    - `PositionDescriptor` string
  - `Vehicles` object[] — Only included when Vehicles=true query parameter is provided
    - `Name` string
    - `Owner` string
    - `Plate` string
    - `Texture` string, nullable
    - `ColorHex` string
    - `ColorName` string

## Other responses

- `400` — Bad request, such as duplicate query parameters.
- `403` — Unauthorized
- `500` — Error communicating with Roblox

---

[API](https://skmtc.dev/erlc/apis/er-lc-private-servers-api-v2.md) · [All operations](https://skmtc.dev/erlc/apis/er-lc-private-servers-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/erlc/er-lc-private-servers-api-v2/revisions/f0b72c41869e/schema)