ROroblox
Game Events

List game events under a universe. Use `?fields=` to trim the response payload. Response is always 200 (empty list for unknown universe).

Changed on
get/virtual-events/v3/universes/{universeId}/game-events

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/virtual-events/v3/universes/{universeId}/game-events
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token scopes: universe.event:read

Path parameters

universeIdinteger required

Universe that owns the events (from path).

Query parameters

pageSizeinteger

Requested page size.

pageTokenstring

Continuation token from a prior page's nextPageToken.

reverseboolean

When true, treats pageToken as a backward-pagination cursor.

startsBeforestring date-time

Upper bound on event start time.

startsAfterstring date-time

Lower bound on event start time.

endsBeforestring date-time

Upper bound on event end time.

endsAfterstring date-time

Lower bound on event end time. Defaults to now when neither bound is set.

visibility'private' | 'public' | 'moderated'

The visibility of a virtual event.

Visibility filter.

fieldsstring

Field mask (comma-separated; omit or * for all fields).

Response

A page of game events.

nextPageTokenstring nullable
previousPageTokenstring nullable

Changes

  • 33047aba4a3dRevision changes
    • info

      api operation id GameEvents_List removed and replaced with GameEvents_GetGameEvents

  • 5dcfa33df56aRevision changes
    • warning

      removed the optional property // from the response with the status

    • info

      removed the invalid enum value from the ////// response property for the response status