Source
This page was generated with Wiki Builder. Do not change the format!
Info
Returns a list of possible users based on the search string
- URI: /User/SearchUsers/
- Basepath: https://www.bungie.net/Platform
- Method: GET
- Service: User
- Permissions: None
- Officially Supported: Yes
Parameters
Path Parameters
None
Query String Parameters
| Name | Schema | Required | Description |
|---|---|---|---|
| q | string | No | The search string. |
Example
Request
GET https://www.bungie.net/Platform/User/SearchUsers/
Response
PlatformErrorCode: 200
{
// Type: GeneralUser[]
"Response": [
// Type: GeneralUser
{
// Type: integer:int64
"membershipId": 0,
// Type: string
"uniqueName": "",
// Type: string
"normalizedName": "",
// Type: string
"displayName": "",
// Type: integer:int32
"profilePicture": 0,
// Type: integer:int32
"profileTheme": 0,
// Type: integer:int32
"userTitle": 0,
// Type: integer:int64
"successMessageFlags": 0,
// Type: boolean
"isDeleted": false,
// Type: string
"about": "",
// Type: string:date-time:nullable
"firstAccess": "",
// Type: string:date-time:nullable
"lastUpdate": "",
// Type: integer:int64:nullable
"legacyPortalUID": 0,
// Type: UserToUserContext
"context": {
// Type: boolean
"isFollowing": false,
// Type: IgnoreResponse
"ignoreStatus": {
// Type: boolean
"isIgnored": false,
// Type: IgnoreStatus:Enum
"ignoreFlags": 0
},
// Type: string:date-time:nullable
"globalIgnoreEndDate": ""
},
// Type: string
"psnDisplayName": "",
// Type: string
"xboxDisplayName": "",
// Type: string
"fbDisplayName": "",
// Type: boolean:nullable
"showActivity": false,
// Type: string
"locale": "",
// Type: boolean
"localeInheritDefault": false,
// Type: integer:int64:nullable
"lastBanReportId": 0,
// Type: boolean
"showGroupMessaging": false,
// Type: string
"profilePicturePath": "",
// Type: string
"profilePictureWidePath": "",
// Type: string
"profileThemeName": "",
// Type: string
"userTitleDisplay": "",
// Type: string
"statusText": "",
// Type: string:date-time
"statusDate": "",
// Type: string:date-time:nullable
"profileBanExpire": "",
// Type: string
"blizzardDisplayName": ""
}
],
// Type: PlatformErrorCodes:Enum
"ErrorCode": 0,
// Type: integer:int32
"ThrottleSeconds": 0,
// Type: string
"ErrorStatus": "",
// Type: string
"Message": "",
// Type: Dictionary<string,string>
"MessageData": {
"{string}": ""
},
// Type: object
}