3 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

GET /virtual-events/v3/game-events/{eventId} — openapi

Get a single game event by ID. Use ?fields= to request a subset of fields; unknown field names return 400.

Endpoint

Method: GET

Path: /virtual-events/v3/game-events/{eventId}

Servers:

• https://apis.roblox.com

Parameters

[
  {
    "name": "eventId",
    "in": "path",
    "description": "Game event ID (from path).",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "name": "fields",
    "in": "query",
    "description": "Optional field mask (comma-separated; omit or use * for all fields).",
    "schema": {
      "type": "string"
    }
  }
]

Responses

{
  "200": {
    "description": "The requested game event.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/GameEventResponse"
        }
      }
    }
  },
  "400": {
    "description": "Malformed `?fields=` or invalid event ID.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/VirtualEventsApi.ProblemDetails"
        }
      }
    }
  },
  "404": {
    "description": "Event does not exist.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/VirtualEventsApi.ProblemDetails"
        }
      }
    }
  }
}

Authentication

{
  "security": [
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": [
        "universe.event:read"
      ]
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Related Schemas

• GameEventResponse

• VirtualEventsApi.ProblemDetails

Complete Operation Definition

{
  "tags": [
    "Game Events"
  ],
  "summary": "Get a single game event by ID.\r\nUse `?fields=` to request a subset of fields; unknown field names return 400.",
  "operationId": "GameEvent_Get",
  "parameters": [
    {
      "name": "eventId",
      "in": "path",
      "description": "Game event ID (from path).",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "fields",
      "in": "query",
      "description": "Optional field mask (comma-separated; omit or use * for all fields).",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "The requested game event.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/GameEventResponse"
          }
        }
      }
    },
    "400": {
      "description": "Malformed `?fields=` or invalid event ID.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VirtualEventsApi.ProblemDetails"
          }
        }
      }
    },
    "404": {
      "description": "Event does not exist.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VirtualEventsApi.ProblemDetails"
          }
        }
      }
    }
  },
  "x-roblox-stability": "EXPERIMENTAL",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 100
    },
    "perOauth2Authorization": {
      "period": "MINUTE",
      "maxInPeriod": 100
    }
  },
  "x-roblox-scopes": [
    {
      "name": "universe.event:read",
      "targetResourceSpecifier": ""
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": [
        "universe.event:read"
      ]
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/virtual-events#GameEvent_Get"
  }
}