Groups v2

Reference for the Groups v2 endpoints on Roblox.

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

Endpoints

Method	Path	Name
`GET`	`/v2/groups`	`getGroups`
`GET`	`/v2/groups/:groupId/experiences`	`getGroupsGroupidExperiences`
`GET`	`/v2/groups/:groupId/relationships/:groupRelationshipType`	`getGroupsGroupidRelationshipsGrouprelationshiptype`
`GET`	`/v2/groups/:groupId/relationships/:groupRelationshipType/requests`	`getGroupsGroupidRelationshipsGrouprelationshiptypeRequests`
`GET`	`/v2/users/:userId/groups/roles`	`getUsersUseridGroupsRoles`

`getGroups`

GET /v2/groups

Multi-get groups information by Ids.

Usage

import { fetchApi } from 'rozod';
import { getGroups } from 'rozod/endpoints/groupsv2';

const data = await fetchApi(getGroups, {
  groupIds: /* number */
});

Parameters

Name	Type	Required	Description
`groupIds`	`number`	Yes	The group Ids.

Response

Field	Type	Description
`data`	`object[]`	See below

data[] item fields:

Field	Type	Description
`id`	`number`
`name`	`string`
`description`	`string`
`owner`	`object`	See below
`memberCount`	`number`
`created`	`string`
`hasVerifiedBadge`	`boolean`

owner fields:

Field	Type	Description
`id`	`number`
`type`	`'User'`
`name`	`string`

Errors

Status	Description
400	2: Too many ids in request. 3: Ids could not be parsed from request.

`getGroupsGroupidExperiences`

GET /v2/groups/:groupId/experiences

Gets experiences created by the specified group id.

Usage

import { fetchApi } from 'rozod';
import { getGroupsGroupidExperiences } from 'rozod/endpoints/groupsv2';

const data = await fetchApi(getGroupsGroupidExperiences, {
  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
501	47: Code path is not implemented.

`getGroupsGroupidRelationshipsGrouprelationshiptype`

GET /v2/groups/:groupId/relationships/:groupRelationshipType

Gets a group’s relationships with cursor-based pagination.

Usage

import { fetchApi } from 'rozod';
import { getGroupsGroupidRelationshipsGrouprelationshiptype } from 'rozod/endpoints/groupsv2';

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

Parameters

Name	Type	Required	Description
`groupId`	`integer`	Yes	The group Id.
`groupRelationshipType`	`string`	Yes	The group relationship type, enemies or allies.
`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
`groupId`	`number`
`relationshipType`	`“Allies”	“Enemies”`
`groupResponses`	`object`	See below

groupResponses fields:

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

data[] item fields:

Field	Type	Description
`id`	`number`
`name`	`string`
`description`	`string`
`owner`	`object`	See below
`shout`	`object`	See below
`memberCount`	`number`
`isBuildersClubOnly`	`boolean`
`publicEntryAllowed`	`boolean`
`isLocked`	`boolean`
`hasVerifiedBadge`	`boolean`
`hasSocialModules`	`boolean`
`communityTier`	`object`	See below

owner fields:

Field	Type	Description
`buildersClubMembershipType`	`0	1
`hasVerifiedBadge`	`boolean`
`userId`	`number`
`username`	`string`
`displayName`	`string`

shout fields:

Field	Type	Description
`body`	`string`
`poster`	`object`	See below
`created`	`string`
`updated`	`string`

poster fields:

Field	Type	Description
`buildersClubMembershipType`	`object`
`hasVerifiedBadge`	`object`
`userId`	`object`
`username`	`object`
`displayName`	`object`

communityTier fields:

Field	Type	Description
`groupId`	`number`
`currentTier`	`number`
`previousTier`	`number \| undefined`
`tierUpdatedTime`	`string \| undefined`
`lastEvaluatedTime`	`string \| undefined`
`requirements`	`object[] \| undefined`	See below
`capabilities`	`object \| undefined`	See below

requirements[] item fields:

Field	Type	Description
`key`	`object`
`satisfied`	`object`

capabilities fields:

Field	Type	Description
`isEligibleForUnrestrictedMessages`	`object`

Errors

Status	Description
400	1: Group is invalid or does not exist. 4: Group relationship type or request type is invalid. 8: Invalid or missing pagination parameters

`getGroupsGroupidRelationshipsGrouprelationshiptypeRequests`

GET /v2/groups/:groupId/relationships/:groupRelationshipType/requests

Gets a group’s relationship requests with cursor-based pagination.

Usage

import { fetchApi } from 'rozod';
import { getGroupsGroupidRelationshipsGrouprelationshiptypeRequests } from 'rozod/endpoints/groupsv2';

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

Parameters

Name	Type	Required	Description
`groupId`	`integer`	Yes	The group Id.
`groupRelationshipType`	`string`	Yes	The group relationship type of the request, only allies are supported.
`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
`groupId`	`number`
`relationshipType`	`“Allies”	“Enemies”`
`groupResponses`	`object`	See below

groupResponses fields:

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

data[] item fields:

Field	Type	Description
`id`	`number`
`name`	`string`
`description`	`string`
`owner`	`object`	See below
`shout`	`object`	See below
`memberCount`	`number`
`isBuildersClubOnly`	`boolean`
`publicEntryAllowed`	`boolean`
`isLocked`	`boolean`
`hasVerifiedBadge`	`boolean`
`hasSocialModules`	`boolean`
`communityTier`	`object`	See below

owner fields:

Field	Type	Description
`buildersClubMembershipType`	`0	1
`hasVerifiedBadge`	`boolean`
`userId`	`number`
`username`	`string`
`displayName`	`string`

shout fields:

Field	Type	Description
`body`	`string`
`poster`	`object`	See below
`created`	`string`
`updated`	`string`

poster fields:

Field	Type	Description
`buildersClubMembershipType`	`object`
`hasVerifiedBadge`	`object`
`userId`	`object`
`username`	`object`
`displayName`	`object`

communityTier fields:

Field	Type	Description
`groupId`	`number`
`currentTier`	`number`
`previousTier`	`number \| undefined`
`tierUpdatedTime`	`string \| undefined`
`lastEvaluatedTime`	`string \| undefined`
`requirements`	`object[] \| undefined`	See below
`capabilities`	`object \| undefined`	See below

requirements[] item fields:

Field	Type	Description
`key`	`object`
`satisfied`	`object`

capabilities fields:

Field	Type	Description
`isEligibleForUnrestrictedMessages`	`object`

Errors

Status	Description
400	1: Group is invalid or does not exist. 4: Group relationship type or request type is invalid. 8: Invalid or missing pagination parameters
401	0: Authorization has been denied for this request.
403	5: You don't have permission to manage this group's relationships.

`getUsersUseridGroupsRoles`

GET /v2/users/:userId/groups/roles

Gets a list of all group roles for groups the specified user is in.

Usage

import { fetchApi } from 'rozod';
import { getUsersUseridGroupsRoles } from 'rozod/endpoints/groupsv2';

const data = await fetchApi(getUsersUseridGroupsRoles, {
  userId: /* integer */,
  includeLocked: /* boolean */,
  includeNotificationPreferences: /* boolean */,
  discoveryType: /* unknown */
});

Parameters

Name	Type	Required	Description
`userId`	`integer`	Yes	The user id.
`includeLocked`	`boolean`	Yes
`includeNotificationPreferences`	`boolean`	Yes
`discoveryType`	`unknown`	Yes

Response

Field	Type	Description
`data`	`object[]`	See below

data[] item fields:

Field	Type	Description
`group`	`object`	See below
`role`	`object`	See below
`isNotificationsEnabled`	`boolean`
`notificationPreferences`	`object[]`	See below

group fields:

Field	Type	Description
`id`	`number`
`name`	`string`
`memberCount`	`number`
`hasVerifiedBadge`	`boolean`

role fields:

Field	Type	Description
`id`	`number`
`name`	`string`
`rank`	`number`

notificationPreferences[] item fields:

Field	Type	Description
`type`	`“AnnouncementCreatedNotification”	“ForumPostCreatedNotification”
`enabled`	`boolean`
`name`	`string`
`description`	`string`

Errors

Status	Description
400	3: The user is invalid or does not exist.