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

guildGetPlayerVip

v1

Check a player's VIP status across all servers in your guild. Returns all VIP entitlements for the given player.

Operation Type

Query

Rate Limit: 1 request per 60 seconds per playerId per guild

VIP status does not change frequently; cache results locally.

Input Fields

FieldTypeRequiredDescription
playerIdString!RequiredPlayer's unique identifier (e.g., Steam ID)

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 { guildGetPlayerVip(playerId: \"PLAYER_STEAM_ID\") { success totalCount entitlements { id gameServerId serverName playerName vipDuration vipExpiresAt vipActive } timestamp } }"
  }'

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": {
    "guildGetPlayerVip": {
      "success": true,
      "totalCount": 2,
      "entitlements": [
        {
          "serverId": "server-abc-123",
          "serverName": "My Community Server #1",
          "isVip": true
        },
        {
          "serverId": "server-def-456",
          "serverName": "My Community Server #2",
          "isVip": false
        }
      ],
      "timestamp": "2025-01-15T12:34:56.789Z"
    }
  }
}

Error Responses

Response Fields

FieldTypeRequiredDescription
successBooleanOptionalWhether the query succeeded
totalCountIntOptionalNumber of VIP entitlements found
entitlementsArrayOptionalVIP entries with: id, gameServerId, serverName, playerName, vipDuration, vipExpiresAt, vipActive
timestampStringOptionalISO 8601 timestamp of the response

In partnership with

Brilliant game servers for communities large and small.

Get yours today!

Shrapnelworks Logo

A Shrapnelworks product