Game Events

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

Changed on
get/virtual-events/v3/game-events/{eventId}

Request

  • Base URL
    https://apis.roblox.com
  • Auth
    • API key in cookie .ROBLOSECURITY
    • or API key in header x-api-key
    • or OAuth 2
      Authorization codehttps://apis.roblox.com/oauth/v1/authorize
      Token URLhttps://apis.roblox.com/oauth/v1/token
      Scopesuniverse.event:read

Path parameters

eventIdstring required

Game event ID (from path).

Query parameters

fieldsstring

Optional field mask (comma-separated; omit or use * for all fields).

Response

The requested game event.

idstring nullable

The unique id of the game event. Always populated. Serialized as a string to preserve precision for clients (event IDs exceed 2^53).

titlestring nullable
displayTitlestring nullable

Localized title (caller's locale). Populated only when displayTitle is in the mask.

subtitlestring nullable
displaySubtitlestring nullable

Localized subtitle. Populated only when displaySubtitle is in the mask.

descriptionstring nullable
displayDescriptionstring nullable

Localized description. Populated only when displayDescription is in the mask.

startTimestring date-time nullable
endTimestring date-time nullable
universeIdinteger nullable
placeIdinteger nullable
visibility'private' | 'public' | 'moderated' nullable

The visibility of a virtual event.

featuringStatus'enabled' | 'disabled' nullable

The featuring status of a virtual event.

taglinestring nullable

Tagline for featuring review; visible to curators only when featuring is opted into.

allThumbnailsCreatedboolean nullable

Whether all requested thumbnails were successfully persisted. Returned on Create/Update.

userRsvpStatus'none' | 'going' | 'maybeGoing' | 'notGoing' nullable

Authenticated caller's RSVP status. Omitted for unauthenticated callers.

createTimestring date-time nullable
updateTimestring date-time nullable

Changes

    • info

      the endpoint scheme security roblox-legacy-cookie was added to the API

    • info

      for the path request parameter eventId, the type was generalized from integer to string, and format from int64 to no format

    • info

      api operation id GameEvent_Get removed and replaced with GameEvent_GetGameEvent