Bifrost Bifrost
POSThttps://api.dev.bifrostgaming.com/v1/graphql

guildGetPlayers

v1

Get a list of all players currently on a remote game server, including their stats, team, role, and other session data.

Operation Type

Query

Rate Limit: 1 request per 30 seconds per server

Designed for near real-time polling of player lists.

Input Fields

FieldTypeRequiredDescription
serverIdID!RequiredUnique server identifier
gameTypeStringOptionalGame type filter

Code Examples

curl -X POST https://api.dev.bifrostgaming.com/v1/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{
    "query": "query { guildGetPlayers(serverId: \"YOUR_SERVER_ID\", gameType: \"HLL\") { players { playerName playerId team role kills deaths score level loadout unit { unitName unitId } } } }"
  }'

Postman Collection

Download a ready-to-use Postman collection for this endpoint. Import it into Postman to start testing immediately.

How to import into Postman
  1. Open Postman and click Import (top-left)
  2. Drag and drop the downloaded .json file, or click Upload Files and select it
  3. Click Import to confirm
  4. The collection appears in your sidebar — expand it and select the request
  5. In the Body tab, update the placeholder values (your-partner-id, etc.) with your actual credentials
  6. Click Send

The collection uses Postman's GraphQL body type, which provides syntax highlighting and variable editing. Make sure your Postman version is 7.2+ for GraphQL support.

Success Response200

{
  "data": {
    "guildGetPlayers": {
      "players": [
        {
          "playerName": "SoldierOne",
          "playerId": "76561198012345678",
          "team": "Allies",
          "role": "Officer",
          "kills": 12,
          "deaths": 5,
          "score": 340,
          "level": 78,
          "loadout": "Rifleman",
          "unit": { "name": "Able", "type": "Infantry" }
        },
        {
          "playerName": "TankCommander",
          "playerId": "76561198087654321",
          "team": "Axis",
          "role": "Crewman",
          "kills": 8,
          "deaths": 3,
          "score": 280,
          "level": 145,
          "loadout": "Crewman",
          "unit": { "name": "Fox", "type": "Armor" }
        }
      ]
    }
  }
}

Error Responses

Response Fields

FieldTypeRequiredDescription
playersArrayOptionalArray of player objects with: playerName, playerId, team, role, kills, deaths, score, level, loadout, unit

In partnership with

Brilliant game servers for communities large and small.

Get yours today!

Shrapnelworks Logo

A Shrapnelworks product