Games v2

Reference for the Games v2 endpoints on Roblox.

Base URL: https://games.roblox.com

Endpoints

Method	Path	Name
GET	/v2/games/:universeId/media	getGamesUniverseidMedia
GET	/v2/users/:userId/favorite/games	getUsersUseridFavoriteGames
GET	/v2/users/:userId/games	getUsersUseridGames
GET	/v2/groups/:groupId/gamesV2	getGroupsGroupidGamesv2
GET	/v2/groups/:groupId/games	getGroupsGroupidGames

getGamesUniverseidMedia

GET /v2/games/:universeId/media

Get the game media data

Usage

import { fetchApi } from 'rozod';
import { getGamesUniverseidMedia } from 'rozod/endpoints/gamesv2';

const data = await fetchApi(getGamesUniverseidMedia, {
  universeId: /* integer */,
  fetchAllExperienceRelatedMedia: /* boolean? */
});

Parameters

Name	Type	Required	Description
universeId	integer	Yes	The id of the universe we get media data from.
fetchAllExperienceRelatedMedia	boolean?	No	to tell if the API query is to fetch all related media for this experience

Response

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
assetTypeId	number
assetType	string
imageId	number
videoHash	string
videoTitle	string
approved	boolean
altText	string
videoId	string

Errors

Status	Description
400	3: The universe's root place is invalid.
404	2: The requested universe does not exist.

---

getUsersUseridFavoriteGames

GET /v2/users/:userId/favorite/games

Gets users favorite games.

Usage

import { fetchApi } from 'rozod';
import { getUsersUseridFavoriteGames } from 'rozod/endpoints/gamesv2';

const data = await fetchApi(getUsersUseridFavoriteGames, {
  userId: /* integer */,
  cursor: /* string? */,
  sortOrder: /* enum */
});

Parameters

Name	Type	Required	Description
userId	integer	Yes	The user Id.
cursor	string?	No	The paging cursor for the previous or next page.
sortOrder	enum	Yes	The order the results are sorted in.

Response

Field	Type	Description
previousPageCursor	string
nextPageCursor	string
data	object[]	See below

data[] item fields:

Field	Type	Description
price	number
contentMetadata	object	See below
id	number
name	string
description	string
creator	object	See below
rootPlace	object	See below
created	string
updated	string
placeVisits	number

contentMetadata fields:

Field	Type	Description
badgePosition	string
badgeAnalyticsId	string
badgeType	string
badgeIcon	string
badgeComponentType	string

creator fields:

Field	Type	Description
id	number
type	`“User”	“Group”`
name	string

rootPlace fields:

Field	Type	Description
id	number
type	`“Image”	“TShirt”
name	string

---

getUsersUseridGames

GET /v2/users/:userId/games

Gets games created by the specified user.

Usage

import { fetchApi } from 'rozod';
import { getUsersUseridGames } from 'rozod/endpoints/gamesv2';

const data = await fetchApi(getUsersUseridGames, {
  userId: /* integer */,
  cursor: /* string? */,
  sortOrder: /* enum */
});

Parameters

Name	Type	Required	Description
userId	integer	Yes	The user Id.
cursor	string?	No	The paging cursor for the previous or next page.
sortOrder	enum	Yes	The order the results are sorted in.

Response

Field	Type	Description
previousPageCursor	string
nextPageCursor	string
data	object[]	See below

data[] item fields:

Field	Type	Description
id	number
name	string
description	string
creator	object	See below
rootPlace	object	See below
created	string
updated	string
placeVisits	number

creator fields:

Field	Type	Description
id	number
type	`“User”	“Group”`
name	string

rootPlace fields:

Field	Type	Description
id	number
type	`“Image”	“TShirt”
name	string

---

getGroupsGroupidGamesv2

GET /v2/groups/:groupId/gamesV2

Gets games created by the specified group. (gamesV2 path - removed from docs)

Usage

import { fetchApi } from 'rozod';
import { getGroupsGroupidGamesv2 } from 'rozod/endpoints/gamesv2';

const data = await fetchApi(getGroupsGroupidGamesv2, {
  groupId: /* integer */,
  cursor: /* string? */,
  sortOrder: /* enum */
});

Parameters

Name	Type	Required	Description
groupId	integer	Yes	The group Id.
cursor	string?	No	The paging cursor for the previous or next page.
sortOrder	enum	Yes	The order the results are sorted in.

Response

Field	Type	Description
previousPageCursor	string
nextPageCursor	string
data	object[]	See below

data[] item fields:

Field	Type	Description
id	number
name	string
description	string
creator	object	See below
rootPlace	object	See below
created	string
updated	string
placeVisits	number

creator fields:

Field	Type	Description
id	number
type	`“User”	“Group”`
name	string

rootPlace fields:

Field	Type	Description
id	number
type	`“Image”	“TShirt”
name	string

Errors

Status	Description
500	0: Compliance Context service is unavailable.
501	1: Code path is not Implemented.

---

getGroupsGroupidGames

GET /v2/groups/:groupId/games

Gets games created by the specified group.

Usage

import { fetchApi } from 'rozod';
import { getGroupsGroupidGames } from 'rozod/endpoints/gamesv2';

const data = await fetchApi(getGroupsGroupidGames, {
  groupId: /* integer */,
  cursor: /* string? */,
  sortOrder: /* enum */
});

Parameters

Name	Type	Required	Description
groupId	integer	Yes	The group Id.
cursor	string?	No	The paging cursor for the previous or next page.
sortOrder	enum	Yes	The order the results are sorted in.

Response

Field	Type	Description
previousPageCursor	string
nextPageCursor	string
data	object[]	See below

data[] item fields:

Field	Type	Description
id	number
name	string
description	string
creator	object	See below
rootPlace	object	See below
created	string
updated	string
placeVisits	number

creator fields:

Field	Type	Description
id	number
type	`“User”	“Group”`
name	string

rootPlace fields:

Field	Type	Description
id	number
type	`“Image”	“TShirt”
name	string

Errors

Status	Description
403	3: Not authorized.
500	0: Compliance Context service is unavailable.

---