Source
This page was generated with Wiki Builder. Do not change the format!
Info
Get information about a specific group with the given name and type.
- URI: /GroupV2/Name/{groupName}/{groupType}/
- Basepath: https://www.bungie.net/Platform
- Method: GET
- Service: GroupV2
- Permissions: None
- Officially Supported: Yes
Parameters
Path Parameters
| Name | Schema | Required | Description |
|---|---|---|---|
| groupName | string | Yes | Exact name of the group to find. |
| groupType | GroupType:Enum | Yes | Type of group to find. |
Query String Parameters
None
Example
Request
GET https://www.bungie.net/Platform/GroupV2/Name/{groupName}/{groupType}/
Response
PlatformErrorCode: 200
{
// Type: GroupResponse
"Response": {
// Type: GroupV2
"detail": {
// Type: integer:int64
"groupId": 0,
// Type: string
"name": "",
// Type: GroupType:Enum
"groupType": 0,
// Type: integer:int64
"membershipIdCreated": 0,
// Type: string:date-time
"creationDate": "",
// Type: string:date-time
"modificationDate": "",
// Type: string
"about": "",
// Type: string[]
"tags": [
// Type: string
""
],
// Type: integer:int32
"memberCount": 0,
// Type: boolean
"isPublic": false,
// Type: boolean
"isPublicTopicAdminOnly": false,
// Type: integer:int64
"primaryAlliedGroupId": 0,
// Type: string
"motto": "",
// Type: boolean
"allowChat": false,
// Type: boolean
"isDefaultPostPublic": false,
// Type: ChatSecuritySetting:Enum
"chatSecurity": 0,
// Type: string
"locale": "",
// Type: integer:int32
"avatarImageIndex": 0,
// Type: GroupHomepage:Enum
"homepage": 0,
// Type: MembershipOption:Enum
"membershipOption": 0,
// Type: GroupPostPublicity:Enum
"defaultPublicity": 0,
// Type: string
"theme": "",
// Type: string
"bannerPath": "",
// Type: string
"avatarPath": "",
// Type: boolean
"isAllianceOwner": false,
// Type: integer:int64
"conversationId": 0,
// Type: boolean
"enableInvitationMessagingForAdmins": false,
// Type: string:date-time:nullable
"banExpireDate": "",
// Type: GroupFeatures
"features": {
// Type: integer:int32
"maximumMembers": 0,
// Type: integer:int32
"maximumMembershipsOfGroupType": 0,
// Type: Capabilities:Enum
"capabilities": 0,
// Type: BungieMembershipType:Enum[]
"membershipTypes": [
// Type: BungieMembershipType:Enum
0
],
// Type: boolean
"invitePermissionOverride": false,
// Type: boolean
"updateCulturePermissionOverride": false,
// Type: HostGuidedGamesPermissionLevel:Enum
"hostGuidedGamePermissionOverride": {},
// Type: boolean
"updateBannerPermissionOverride": false,
// Type: RuntimeGroupMemberType:Enum
"joinLevel": {}
},
// Type: GroupV2ClanInfoAndInvestment
"clanInfo": {
// Type: Dictionary<integer:uint32,DestinyProgression>
"d2ClanProgressions": {
"0": {
// Type: Destiny.Definitions.DestinyProgressionDefinition:integer:uint32
"progressionHash": 0,
// Type: integer:int32
"dailyProgress": 0,
// Type: integer:int32
"dailyLimit": 0,
// Type: integer:int32
"weeklyProgress": 0,
// Type: integer:int32
"weeklyLimit": 0,
// Type: integer:int32
"currentProgress": 0,
// Type: integer:int32
"level": 0,
// Type: integer:int32
"levelCap": 0,
// Type: integer:int32
"stepIndex": 0,
// Type: integer:int32
"progressToNextLevel": 0,
// Type: integer:int32
"nextLevelAt": 0
}
},
// Type: string
"clanCallsign": "",
// Type: ClanBanner
"clanBannerData": {
// Type: integer:uint32
"decalId": 0,
// Type: integer:uint32
"decalColorId": 0,
// Type: integer:uint32
"decalBackgroundColorId": 0,
// Type: integer:uint32
"gonfalonId": 0,
// Type: integer:uint32
"gonfalonColorId": 0,
// Type: integer:uint32
"gonfalonDetailId": 0,
// Type: integer:uint32
"gonfalonDetailColorId": 0
}
}
},
// Type: GroupMember
"founder": {
// Type: RuntimeGroupMemberType:Enum
"memberType": 0,
// Type: boolean
"isOnline": false,
// Type: integer:int64
"groupId": 0,
// Type: UserInfoCard
"destinyUserInfo": {
// Type: string
"supplementalDisplayName": "",
// Type: string
"iconPath": "",
// Type: BungieMembershipType:Enum
"membershipType": {},
// Type: integer:int64
"membershipId": 0,
// Type: string
"displayName": ""
},
// Type: UserInfoCard
"bungieNetUserInfo": {
// Type: string
"supplementalDisplayName": "",
// Type: string
"iconPath": "",
// Type: BungieMembershipType:Enum
"membershipType": {},
// Type: integer:int64
"membershipId": 0,
// Type: string
"displayName": ""
},
// Type: string:date-time
"joinDate": ""
},
// Type: integer:int64[]
"alliedIds": [
// Type: integer:int64
0
],
// Type: GroupV2
"parentGroup": {
// Type: integer:int64
"groupId": 0,
// Type: string
"name": "",
// Type: GroupType:Enum
"groupType": 0,
// Type: integer:int64
"membershipIdCreated": 0,
// Type: string:date-time
"creationDate": "",
// Type: string:date-time
"modificationDate": "",
// Type: string
"about": "",
// Type: string[]
"tags": [
// Type: string
""
],
// Type: integer:int32
"memberCount": 0,
// Type: boolean
"isPublic": false,
// Type: boolean
"isPublicTopicAdminOnly": false,
// Type: integer:int64
"primaryAlliedGroupId": 0,
// Type: string
"motto": "",
// Type: boolean
"allowChat": false,
// Type: boolean
"isDefaultPostPublic": false,
// Type: ChatSecuritySetting:Enum
"chatSecurity": 0,
// Type: string
"locale": "",
// Type: integer:int32
"avatarImageIndex": 0,
// Type: GroupHomepage:Enum
"homepage": 0,
// Type: MembershipOption:Enum
"membershipOption": 0,
// Type: GroupPostPublicity:Enum
"defaultPublicity": 0,
// Type: string
"theme": "",
// Type: string
"bannerPath": "",
// Type: string
"avatarPath": "",
// Type: boolean
"isAllianceOwner": false,
// Type: integer:int64
"conversationId": 0,
// Type: boolean
"enableInvitationMessagingForAdmins": false,
// Type: string:date-time:nullable
"banExpireDate": "",
// Type: GroupFeatures
"features": {
// Type: integer:int32
"maximumMembers": 0,
// Type: integer:int32
"maximumMembershipsOfGroupType": 0,
// Type: Capabilities:Enum
"capabilities": 0,
// Type: BungieMembershipType:Enum[]
"membershipTypes": [
// Type: BungieMembershipType:Enum
0
],
// Type: boolean
"invitePermissionOverride": false,
// Type: boolean
"updateCulturePermissionOverride": false,
// Type: HostGuidedGamesPermissionLevel:Enum
"hostGuidedGamePermissionOverride": {},
// Type: boolean
"updateBannerPermissionOverride": false,
// Type: RuntimeGroupMemberType:Enum
"joinLevel": {}
},
// Type: GroupV2ClanInfoAndInvestment
"clanInfo": {
// Type: Dictionary<integer:uint32,DestinyProgression>
"d2ClanProgressions": {
"0": {
// Type: Destiny.Definitions.DestinyProgressionDefinition:integer:uint32
"progressionHash": 0,
// Type: integer:int32
"dailyProgress": 0,
// Type: integer:int32
"dailyLimit": 0,
// Type: integer:int32
"weeklyProgress": 0,
// Type: integer:int32
"weeklyLimit": 0,
// Type: integer:int32
"currentProgress": 0,
// Type: integer:int32
"level": 0,
// Type: integer:int32
"levelCap": 0,
// Type: integer:int32
"stepIndex": 0,
// Type: integer:int32
"progressToNextLevel": 0,
// Type: integer:int32
"nextLevelAt": 0
}
},
// Type: string
"clanCallsign": "",
// Type: ClanBanner
"clanBannerData": {
// Type: integer:uint32
"decalId": 0,
// Type: integer:uint32
"decalColorId": 0,
// Type: integer:uint32
"decalBackgroundColorId": 0,
// Type: integer:uint32
"gonfalonId": 0,
// Type: integer:uint32
"gonfalonColorId": 0,
// Type: integer:uint32
"gonfalonDetailId": 0,
// Type: integer:uint32
"gonfalonDetailColorId": 0
}
}
},
// Type: GroupAllianceStatus:Enum
"allianceStatus": 0,
// Type: integer:int32
"groupJoinInviteCount": 0,
// Type: Dictionary<BungieMembershipType:Enum,GroupMember>
"currentUserMemberMap": {
"0": {
// Type: RuntimeGroupMemberType:Enum
"memberType": 0,
// Type: boolean
"isOnline": false,
// Type: integer:int64
"groupId": 0,
// Type: UserInfoCard
"destinyUserInfo": {
// Type: string
"supplementalDisplayName": "",
// Type: string
"iconPath": "",
// Type: BungieMembershipType:Enum
"membershipType": {},
// Type: integer:int64
"membershipId": 0,
// Type: string
"displayName": ""
},
// Type: UserInfoCard
"bungieNetUserInfo": {
// Type: string
"supplementalDisplayName": "",
// Type: string
"iconPath": "",
// Type: BungieMembershipType:Enum
"membershipType": {},
// Type: integer:int64
"membershipId": 0,
// Type: string
"displayName": ""
},
// Type: string:date-time
"joinDate": ""
}
},
// Type: Dictionary<BungieMembershipType:Enum,GroupPotentialMember>
"currentUserPotentialMemberMap": {
"0": {
// Type: GroupPotentialMemberStatus:Enum
"potentialStatus": 0,
// Type: integer:int64
"groupId": 0,
// Type: UserInfoCard
"destinyUserInfo": {
// Type: string
"supplementalDisplayName": "",
// Type: string
"iconPath": "",
// Type: BungieMembershipType:Enum
"membershipType": {},
// Type: integer:int64
"membershipId": 0,
// Type: string
"displayName": ""
},
// Type: UserInfoCard
"bungieNetUserInfo": {
// Type: string
"supplementalDisplayName": "",
// Type: string
"iconPath": "",
// Type: BungieMembershipType:Enum
"membershipType": {},
// Type: integer:int64
"membershipId": 0,
// Type: string
"displayName": ""
},
// Type: string:date-time
"joinDate": ""
}
}
},
// Type: PlatformErrorCodes:Enum
"ErrorCode": 0,
// Type: integer:int32
"ThrottleSeconds": 0,
// Type: string
"ErrorStatus": "",
// Type: string
"Message": "",
// Type: Dictionary<string,string>
"MessageData": {
"{string}": ""
},
// Type: object
}