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

guildGetPlayers

v1

Returns a snapshot of every player currently on the specified server, enriched with per-player scoring (combat / offense / defense / support), role, squad, team, faction, VIP status, and any active Bifrost flags assigned by your guild. Backed by the in-game RCON session feed; the snapshot timestamp tells you how fresh the data is (typically under 30s old).

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 (UUID).
gameTypeStringOptionalGame type code. Defaults to "HLL".

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\") { timestamp totalCount roles { roleIndex roleName } players { eosId playerId playerName playerClanTag platform level squad role team faction isVip flags { flagId flagName flagSource flagColor flagNote createdAt } combatScore offenseScore defenseScore supportScore kills deaths teamkills } } }"
  }'

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": {
      "timestamp": "2026-05-24T14:08:14Z",
      "totalCount": 2,
      "roles": [
        { "roleIndex": 0, "roleName": "Rifleman" },
        { "roleIndex": 9, "roleName": "Squad Leader" },
        { "roleIndex": 13, "roleName": "Commander" }
      ],
      "players": [
        {
          "eosId": "0002503284224769bfb8a580c9d43ef1",
          "playerId": "76561198012345678",
          "playerName": "ExamplePlayerOne",
          "playerClanTag": "DSS",
          "platform": "steam",
          "level": 78,
          "squad": "ABLE",
          "role": "Squad Leader",
          "team": "Allies",
          "faction": "Soviets",
          "isVip": false,
          "flags": [],
          "combatScore": 1243,
          "offenseScore": 400,
          "defenseScore": 380,
          "supportScore": 165,
          "kills": 58,
          "deaths": 12,
          "teamkills": 0
        },
        {
          "eosId": null,
          "playerId": "76561198087654321",
          "playerName": "ExamplePlayerTwo",
          "playerClanTag": "",
          "platform": "steam",
          "level": 145,
          "squad": "FOX",
          "role": "Rifleman",
          "team": "Axis",
          "faction": "Germany",
          "isVip": true,
          "flags": [
            {
              "flagId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
              "flagName": "Watchlist",
              "flagSource": "guild",
              "flagColor": "#FFA500",
              "flagNote": "Reported by mod team 2026-04-12",
              "createdAt": "2026-04-12T18:23:11Z"
            }
          ],
          "combatScore": 324,
          "offenseScore": 200,
          "defenseScore": 520,
          "supportScore": 475,
          "kills": 34,
          "deaths": 8,
          "teamkills": 0
        }
      ]
    }
  }
}

Error Responses

Response Fields

FieldTypeRequiredDescription
roles[GuildPlayerRole!]!RequiredAll player roles defined for the requested gameType (not just roles currently present on the server). Use to translate role indices to names.
players[GuildEnrichedPlayer!]!RequiredEnriched player records. Empty array when the server is empty.
timestampString!RequiredISO 8601 timestamp of when the underlying RCON snapshot was captured.
totalCountInt!RequiredEquals players.length.
roles[].roleIndexInt!RequiredNumeric role index used by the game engine (e.g. 0 = Rifleman, 9 = Squad Leader, 13 = Commander for HLL).
roles[].roleNameString!RequiredHuman-readable role name (e.g. "Rifleman", "Squad Leader", "Tank Commander").
players[].playerIdString!RequiredPlatform-specific player ID. Steam64 (17-digit numeric) for Steam; hex string for PSN / Xbox.
players[].playerNameString!RequiredIn-game display name.
players[].eosIdStringOptionalEpic Online Services ID (cross-platform). Null when the server has not reported one.
players[].playerClanTagStringOptionalClan tag (e.g. "13SNC"). Empty string when the player has none set.
players[].platformStringOptionalPlayer platform. One of "steam", "psn", "xbl". Null if unreported.
players[].levelIntOptionalPlayer level in the game. Null if unreported.
players[].squadStringOptionalSquad name (e.g. "ABLE", "DOG"). Empty string when the player is not in a squad.
players[].roleStringOptionalHuman-readable role name (matches roles[].roleName). Null if the player's role index is unknown or unreported.
players[].teamStringOptionalOne of "Allies" or "Axis". Null if current game state has not been resolved for this server.
players[].factionStringOptionalFaction name for the player's team on the current map (e.g. "Soviets", "Germany", "US"). Null if game state or map metadata is unavailable.
players[].isVipBoolean!RequiredTrue if this player has an active VIP entitlement recorded in your guild for this server.
players[].flags[GuildPlayerFlag!]!RequiredActive Bifrost flags assigned to this player by your guild. Empty array when none.
players[].combatScoreIntOptionalCurrent-match combat score reported by the game. Null if unreported.
players[].offenseScoreIntOptionalCurrent-match offense score. Null if unreported.
players[].defenseScoreIntOptionalCurrent-match defense score. Null if unreported.
players[].supportScoreIntOptionalCurrent-match support score. Null if unreported.
players[].killsIntOptionalCurrent-match infantry kill count (does not include vehicle kills). Null if unreported.
players[].deathsIntOptionalCurrent-match death count. Null if unreported.
players[].teamkillsIntOptionalCurrent-match team-kill count. Null if unreported.
players[].flags[].flagIdStringOptionalFlag identifier. For guild custom flags this is the guild-custom flag UUID; for system flags this is the system flag ID. Null if neither resolves.
players[].flags[].flagNameString!RequiredHuman-readable flag name (e.g. "Cheater", "Watchlist", "Banned Elsewhere").
players[].flags[].flagSourceString!RequiredOrigin of the flag. One of "system" (Bifrost-wide) or "guild" (your guild's custom flag).
players[].flags[].flagColorStringOptionalHex color (e.g. "#FFA500") used for UI rendering. Null if not set.
players[].flags[].flagNoteStringOptionalOptional free-form note attached when the flag was raised.
players[].flags[].createdAtString!RequiredISO 8601 timestamp when the flag was raised.
Shrapnelworks Logo

A Shrapnelworks product