Source
This page was generated with Wiki Builder. Do not change the format!
Info
Search for Groups.
- URI: /GroupV2/Search/
- Basepath: https://www.bungie.net/Platform
- Method: POST
- Service: GroupV2
- Permissions: None
- Officially Supported: Yes
Parameters
Path Parameters
None
Query String Parameters
None
Example
Request
POST https://www.bungie.net/Platform/GroupV2/Search/
{
// Type: string
"name": "",
// Type: GroupType:Enum
"groupType": 0,
// Type: GroupDateRange:Enum
"creationDate": 0,
// Type: GroupSortBy:Enum
"sortBy": 0,
// Type: integer:int32:nullable
"groupMemberCountFilter": 0,
// Type: string
"localeFilter": "",
// Type: string
"tagText": "",
// Type: integer:int32
"itemsPerPage": 0,
// Type: integer:int32
"currentPage": 0,
// Type: string
"requestContinuationToken": "",
// Type: GroupQuery
}
Response
PlatformErrorCode: 200
{
// Type: GroupSearchResponse
"Response": {
// Type: GroupV2Card[]
"results": [
// Type: GroupV2Card
{
// Type: integer:int64
"groupId": 0,
// Type: string
"name": "",
// Type: GroupType:Enum
"groupType": 0,
// Type: string:date-time
"creationDate": "",
// Type: string
"about": "",
// Type: string
"motto": "",
// Type: integer:int32
"memberCount": 0,
// Type: string
"locale": "",
// Type: MembershipOption:Enum
"membershipOption": 0,
// Type: Capabilities:Enum
"capabilities": 0,
// Type: GroupV2ClanInfo
"clanInfo": {
// 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: string
"avatarPath": "",
// Type: string
"theme": ""
}
],
// Type: integer:int32
"totalResults": 0,
// Type: boolean
"hasMore": false,
// Type: PagedQuery
"query": {
// Type: integer:int32
"itemsPerPage": 0,
// Type: integer:int32
"currentPage": 0,
// Type: string
"requestContinuationToken": ""
},
// Type: string
"replacementContinuationToken": "",
// Type: boolean
"useTotalResults": false
},
// Type: PlatformErrorCodes:Enum
"ErrorCode": 0,
// Type: integer:int32
"ThrottleSeconds": 0,
// Type: string
"ErrorStatus": "",
// Type: string
"Message": "",
// Type: Dictionary<string,string>
"MessageData": {
"{string}": ""
},
// Type: object
}