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.

GameEventResponse — openapi

v3 game event response. All fields except VirtualEventsApi.Models.V3.Response.GameEventResponse.Id are gated by the ?fields= mask.

Properties

Related Schemas

• HostResponse

• EventVisibility

• FeaturingStatus

• CategoryResponse

• ThumbnailResponse

• ConfigResponse

• RsvpStatus

Complete Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique id of the game event. Always populated. Serialized as a string to\r\npreserve precision for clients (event IDs exceed 2^53).",
      "nullable": true
    },
    "title": {
      "type": "string",
      "nullable": true
    },
    "displayTitle": {
      "type": "string",
      "description": "Localized title (caller's locale). Populated only when `displayTitle` is in the mask.",
      "nullable": true
    },
    "subtitle": {
      "type": "string",
      "nullable": true
    },
    "displaySubtitle": {
      "type": "string",
      "description": "Localized subtitle. Populated only when `displaySubtitle` is in the mask.",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "displayDescription": {
      "type": "string",
      "description": "Localized description. Populated only when `displayDescription` is in the mask.",
      "nullable": true
    },
    "startTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "endTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "universeId": {
      "type": "integer",
      "format": "int64",
      "nullable": true
    },
    "placeId": {
      "type": "integer",
      "format": "int64",
      "nullable": true
    },
    "host": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HostResponse"
        }
      ],
      "description": "Host block. VirtualEventsApi.Models.V3.Response.HostResponse.HostName and VirtualEventsApi.Models.V3.Response.HostResponse.HasVerifiedBadge are omitted when host-details resolution failed.",
      "nullable": true
    },
    "visibility": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventVisibility"
        }
      ],
      "nullable": true
    },
    "featuringStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FeaturingStatus"
        }
      ],
      "nullable": true
    },
    "tagline": {
      "type": "string",
      "description": "Tagline for featuring review; visible to curators only when featuring is opted into.",
      "nullable": true
    },
    "categories": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CategoryResponse"
      },
      "nullable": true
    },
    "thumbnails": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ThumbnailResponse"
      },
      "nullable": true
    },
    "allThumbnailsCreated": {
      "type": "boolean",
      "description": "Whether all requested thumbnails were successfully persisted. Returned on Create/Update.",
      "nullable": true
    },
    "config": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConfigResponse"
        }
      ],
      "nullable": true
    },
    "userRsvpStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RsvpStatus"
        }
      ],
      "description": "Authenticated caller's RSVP status. Omitted for unauthenticated callers.",
      "nullable": true
    },
    "createTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "updateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "v3 game event response. All fields except VirtualEventsApi.Models.V3.Response.GameEventResponse.Id are gated by the `?fields=` mask."
}