Get Guild Info — partnerGetGuildInfo | Bifrost Developer Center

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

partnerGetGuildInfo

Look up a Bifrost guild by its OAuth client ID, scoped to a game type. Returns the guild only when it has at least one active server of the requested game type. Useful for partner integrations that need to resolve a guild reference before issuing other partner calls (for example, before adding a Ragnarok ban).

Operation Type

Query

Rate Limit: 60 requests / 60 seconds per partner

Important usage notes

Returns null (not an error) if no guild matches the OAuth client ID OR if the matching guild has no active server of the given game type.
guildClientId is the guild's OAuth client ID as configured on the Bifrost guild record. It is NOT the same as the guild UUID, the Keycloak group name, or the Discord guild ID.
gameType matching is case-insensitive (it is uppercased server-side).
The returned guildId is the canonical Bifrost UUID — use it for any subsequent guild-scoped partner calls.

Input Fields

Field	Type	Required	Description
`partnerId`	String!	Required	Your unique partner identifier.
`partnerEncryptionKey`	String!	Required	Your partner encryption key (Base64-encoded).
`guildClientId`	String!	Required	The guild OAuth client ID, as configured on the Bifrost guild record.
`gameType`	String!	Required	The game type code (e.g. "HLL"). The guild must have at least one active server of this game type.

Code Examples

curl -X POST https://api.dev.bifrostgaming.com/v1/graphql \
  -H "Content-Type: application/json" \
  -d '{
    "query": "query PartnerGetGuildInfo($partnerId: String!, $partnerEncryptionKey: String!, $guildClientId: String!, $gameType: String!) { partnerGetGuildInfo(partnerId: $partnerId, partnerEncryptionKey: $partnerEncryptionKey, guildClientId: $guildClientId, gameType: $gameType) { guildId guildName guildTag guildDiscordUrl } }",
    "variables": {
      "partnerId": "your-partner-id",
      "partnerEncryptionKey": "your-base64-encryption-key",
      "guildClientId": "the-guild-oauth-client-id",
      "gameType": "HLL"
    }
  }'

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

Open Postman and click Import (top-left)
Drag and drop the downloaded .json file, or click Upload Files and select it
Click Import to confirm
The collection appears in your sidebar — expand it and select the request
In the Body tab, update the placeholder values (your-partner-id, etc.) with your actual credentials
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": {
    "partnerGetGuildInfo": {
      "guildId": "48999d4d-41f3-4456-8dcb-4600af60e848",
      "guildName": "[13SNC]",
      "guildTag": "13SNC",
      "guildDiscordUrl": "https://discord.gg/example"
    }
  }
}

Error Responses

Response Fields

Field	Type	Required	Description
`guildId`	String	Required	The Bifrost guild UUID. Use this with partnerAddRagnarokBan and other guild-scoped partner endpoints.
`guildName`	String	Required	The full guild name.
`guildTag`	String	Required	The short guild tag / abbreviation.
`guildDiscordUrl`	String	Required	The guild's Discord invite URL.

In partnership with

Brilliant game servers for communities large and small.

Get yours today!

A Shrapnelworks product