@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Bungie.Net API
@base https://www.bungie.net/Platform
@version 2.21.9
@auth ApiKey X-API-Key in header | OAuth2
@endpoints 135
@hint download_for_search
@toc App(2), User(9), Content(7), Forum(10), GroupV2(35), Tokens(8), Destiny2(43), CommunityContent(1), Trending(3), Fireteam(5), Social(8), GetAvailableLocales(1), Settings(1), UserSystemOverrides(1), GlobalAlerts(1)

@group App
@endpoint GET /App/ApiUsage/{applicationId}/
@desc Get API usage by application for time frame specified. You can go as far back as 30 days ago, and can ask for up to a 48 hour window of time in a single request. You must be authenticated with at least the ReadUserData permission to access this endpoint.
@required {applicationId: any # ID of the application to get usage statistics.}
@optional {end: any # End time for query. Goes to now if not specified., start: any # Start time for query. Goes to 24 hours ago if not specified.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /App/FirstParty/
@desc Get list of applications created by Bungie.
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@group User
@endpoint GET /User/GetBungieNetUserById/{id}/
@desc Loads a bungienet user by membership id.
@required {id: any # The requested Bungie.net membership id.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /User/GetSanitizedPlatformDisplayNames/{membershipId}/
@desc Gets a list of all display names linked to this membership id but sanitized (profanity filtered). Obeys all visibility rules of calling user and is heavily cached.
@required {membershipId: any # The requested membership id to load.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /User/GetCredentialTypesForTargetAccount/{membershipId}/
@desc Returns a list of credential types attached to the requested account
@required {membershipId: any # The user's membership id}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /User/GetAvailableThemes/
@desc Returns a list of all available user themes.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /User/GetMembershipsById/{membershipId}/{membershipType}/
@desc Returns a list of accounts associated with the supplied membership ID and membership type. This will include all linked accounts (even when hidden) if supplied credentials permit it.
@required {membershipId: any # The membership ID of the target user., membershipType: any # Type of the supplied membership ID.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /User/GetMembershipsForCurrentUser/
@desc Returns a list of accounts associated with signed in user. This is useful for OAuth implementations that do not give you access to the token response.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /User/GetMembershipFromHardLinkedCredential/{crType}/{credential}/
@desc Gets any hard linked membership given a credential. Only works for credentials that are public (just SteamID64 right now). Cross Save aware.
@required {credential: any # The credential to look up. Must be a valid SteamID64., crType: any # The credential type. 'SteamId' is the only valid value at present.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /User/Search/Prefix/{displayNamePrefix}/{page}/
@desc [OBSOLETE] Do not use this to search users, use SearchByGlobalNamePost instead.
@required {displayNamePrefix: any # The display name prefix you're looking for., page: any # The zero-based page of results you desire.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /User/Search/GlobalName/{page}/
@desc Given the prefix of a global display name, returns all users who share that name.
@required {page: any # The zero-based page of results you desire.}
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@group Content
@endpoint GET /Content/GetContentType/{type}/
@desc Gets an object describing a particular variant of content.
@required {type: any}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Content/GetContentById/{id}/{locale}/
@desc Returns a content item referenced by id
@required {id: any, locale: any}
@optional {head: any # false}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Content/GetContentByTagAndType/{tag}/{type}/{locale}/
@desc Returns the newest item that matches a given tag and Content Type.
@required {locale: any, tag: any, type: any}
@optional {head: any # Not used.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Content/Search/{locale}/
@desc Gets content based on querystring information passed in. Provides basic search and text search capabilities.
@required {locale: any}
@optional {ctype: any # Content type tag: Help, News, etc. Supply multiple ctypes separated by space., currentpage: any # Page number for the search results, starting with page 1., head: any # Not used., searchtext: any # Word or phrase for the search., source: any # For analytics, hint at the part of the app that triggered the search. Optional., tag: any # Tag used on the content to be searched.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Content/SearchContentByTagAndType/{tag}/{type}/{locale}/
@desc Searches for Content Items that match the given Tag and Content Type.
@required {locale: any, tag: any, type: any}
@optional {currentpage: any # Page number for the search results starting with page 1., head: any # Not used., itemsperpage: any # Not used.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Content/SearchHelpArticles/{searchtext}/{size}/
@desc Search for Help Articles.
@required {searchtext: any, size: any}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Content/Rss/NewsArticles/{pageToken}/
@desc Returns a JSON string response that is the RSS feed for news articles.
@required {pageToken: any # Zero-based pagination token for paging through result sets.}
@optional {categoryfilter: any # Optionally filter response to only include news items in a certain category., includebody: any # Optionally include full content body for each news item.}
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@group Forum
@endpoint GET /Forum/GetTopicsPaged/{page}/{pageSize}/{group}/{sort}/{quickDate}/{categoryFilter}/
@desc Get topics from any forum.
@required {categoryFilter: any # A category filter, group: any # The group, if any., page: any # Zero paged page number, pageSize: any # Unused, quickDate: any # A date filter., sort: any # The sort mode.}
@optional {locales: any # Comma seperated list of locales posts must match to return in the result list. Default 'en', tagstring: any # The tags to search, if any.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Forum/GetCoreTopicsPaged/{page}/{sort}/{quickDate}/{categoryFilter}/
@desc Gets a listing of all topics marked as part of the core group.
@required {categoryFilter: any # The category filter., page: any # Zero base page, quickDate: any # The date filter., sort: any # The sort mode.}
@optional {locales: any # Comma seperated list of locales posts must match to return in the result list. Default 'en'}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Forum/GetPostsThreadedPaged/{parentPostId}/{page}/{pageSize}/{replySize}/{getParentPost}/{rootThreadMode}/{sortMode}/
@desc Returns a thread of posts at the given parent, optionally returning replies to those posts as well as the original parent.
@required {getParentPost: any, page: any, pageSize: any, parentPostId: any, replySize: any, rootThreadMode: any, sortMode: any}
@optional {showbanned: any # If this value is not null or empty, banned posts are requested to be returned}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Forum/GetPostsThreadedPagedFromChild/{childPostId}/{page}/{pageSize}/{replySize}/{rootThreadMode}/{sortMode}/
@desc Returns a thread of posts starting at the topicId of the input childPostId, optionally returning replies to those posts as well as the original parent.
@required {childPostId: any, page: any, pageSize: any, replySize: any, rootThreadMode: any, sortMode: any}
@optional {showbanned: any # If this value is not null or empty, banned posts are requested to be returned}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Forum/GetPostAndParent/{childPostId}/
@desc Returns the post specified and its immediate parent.
@required {childPostId: any}
@optional {showbanned: any # If this value is not null or empty, banned posts are requested to be returned}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Forum/GetPostAndParentAwaitingApproval/{childPostId}/
@desc Returns the post specified and its immediate parent of posts that are awaiting approval.
@required {childPostId: any}
@optional {showbanned: any # If this value is not null or empty, banned posts are requested to be returned}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Forum/GetTopicForContent/{contentId}/
@desc Gets the post Id for the given content item's comments, if it exists.
@required {contentId: any}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Forum/GetForumTagSuggestions/
@desc Gets tag suggestions based on partial text entry, matching them with other tags previously used in the forums.
@optional {partialtag: any # The partial tag input to generate suggestions from.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Forum/Poll/{topicId}/
@desc Gets the specified forum poll.
@required {topicId: any # The post id of the topic that has the poll.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Forum/Recruit/Summaries/
@desc Allows the caller to get a list of to 25 recruitment thread summary information objects.
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@group GroupV2
@endpoint GET /GroupV2/GetAvailableAvatars/
@desc Returns a list of all available group avatars for the signed-in user.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /GroupV2/GetAvailableThemes/
@desc Returns a list of all available group themes.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /GroupV2/GetUserClanInviteSetting/{mType}/
@desc Gets the state of the user's clan invite preferences for a particular membership type - true if they wish to be invited to clans, false otherwise.
@required {mType: any # The Destiny membership type of the account we wish to access settings.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/Recommended/{groupType}/{createDateRange}/
@desc Gets groups recommended for you based on the groups to whom those you follow belong.
@required {createDateRange: any # Requested range in which to pull recommended groups, groupType: any # Type of groups requested}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/Search/
@desc Search for Groups.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /GroupV2/{groupId}/
@desc Get information about a specific group of the given ID.
@required {groupId: any # Requested group's id.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /GroupV2/Name/{groupName}/{groupType}/
@desc Get information about a specific group with the given name and type.
@required {groupName: any # Exact name of the group to find., groupType: any # Type of group to find.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/NameV2/
@desc Get information about a specific group with the given name and type. The POST version.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /GroupV2/{groupId}/OptionalConversations/
@desc Gets a list of available optional conversation channels and their settings.
@required {groupId: any # Requested group's id.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/Edit/
@desc Edit an existing group. You must have suitable permissions in the group to perform this operation. This latest revision will only edit the fields you pass in - pass null for properties you want to leave unaltered.
@required {groupId: any # Group ID of the group to edit.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/EditClanBanner/
@desc Edit an existing group's clan banner. You must have suitable permissions in the group to perform this operation. All fields are required.
@required {groupId: any # Group ID of the group to edit.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/EditFounderOptions/
@desc Edit group options only available to a founder. You must have suitable permissions in the group to perform this operation.
@required {groupId: any # Group ID of the group to edit.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/OptionalConversations/Add/
@desc Add a new optional conversation/chat channel. Requires admin permissions to the group.
@required {groupId: any # Group ID of the group to edit.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/OptionalConversations/Edit/{conversationId}/
@desc Edit the settings of an optional conversation/chat channel. Requires admin permissions to the group.
@required {conversationId: any # Conversation Id of the channel being edited., groupId: any # Group ID of the group to edit.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /GroupV2/{groupId}/Members/
@desc Get the list of members in a given group.
@required {currentpage: any # Page number (starting with 1). Each page has a fixed size of 50 items per page., groupId: any # The ID of the group.}
@optional {memberType: any # Filter out other member types. Use None for all members., nameSearch: any # The name fragment upon which a search should be executed for members with matching display or unique names.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /GroupV2/{groupId}/AdminsAndFounder/
@desc Get the list of members in a given group who are of admin level or higher.
@required {currentpage: any # Page number (starting with 1). Each page has a fixed size of 50 items per page., groupId: any # The ID of the group.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/Members/{membershipType}/{membershipId}/SetMembershipType/{memberType}/
@desc Edit the membership type of a given member. You must have suitable permissions in the group to perform this operation.
@required {groupId: any # ID of the group to which the member belongs., membershipId: any # Membership ID to modify., membershipType: any # Membership type of the provide membership ID., memberType: any # New membertype for the specified member.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/Members/{membershipType}/{membershipId}/Kick/
@desc Kick a member from the given group, forcing them to reapply if they wish to re-join the group. You must have suitable permissions in the group to perform this operation.
@required {groupId: any # Group ID to kick the user from., membershipId: any # Membership ID to kick., membershipType: any # Membership type of the provided membership ID.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/Members/{membershipType}/{membershipId}/Ban/
@desc Bans the requested member from the requested group for the specified period of time.
@required {groupId: any # Group ID that has the member to ban., membershipId: any # Membership ID of the member to ban from the group., membershipType: any # Membership type of the provided membership ID.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/Members/{membershipType}/{membershipId}/Unban/
@desc Unbans the requested member, allowing them to re-apply for membership.
@required {groupId: any, membershipId: any # Membership ID of the member to unban from the group, membershipType: any # Membership type of the provided membership ID.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /GroupV2/{groupId}/Banned/
@desc Get the list of banned members in a given group. Only accessible to group Admins and above. Not applicable to all groups. Check group features.
@required {currentpage: any # Page number (starting with 1). Each page has a fixed size of 50 entries., groupId: any # Group ID whose banned members you are fetching}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /GroupV2/{groupId}/EditHistory/
@desc Get the list of edits made to a given group. Only accessible to group Admins and above.
@required {currentpage: any # Page number (starting with 1). Each page has a fixed size of 50 entries., groupId: any # Group ID whose edit history you are fetching}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/Admin/AbdicateFoundership/{membershipType}/{founderIdNew}/
@desc An administrative method to allow the founder of a group or clan to give up their position to another admin permanently.
@required {founderIdNew: any # The new founder for this group. Must already be a group admin., groupId: any # The target group id., membershipType: any # Membership type of the provided founderIdNew.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /GroupV2/{groupId}/Members/Pending/
@desc Get the list of users who are awaiting a decision on their application to join a given group. Modified to include application info.
@required {currentpage: any # Page number (starting with 1). Each page has a fixed size of 50 items per page., groupId: any # ID of the group.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /GroupV2/{groupId}/Members/InvitedIndividuals/
@desc Get the list of users who have been invited into the group.
@required {currentpage: any # Page number (starting with 1). Each page has a fixed size of 50 items per page., groupId: any # ID of the group.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/Members/ApproveAll/
@desc Approve all of the pending users for the given group.
@required {groupId: any # ID of the group.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/Members/DenyAll/
@desc Deny all of the pending users for the given group.
@required {groupId: any # ID of the group.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/Members/ApproveList/
@desc Approve all of the pending users for the given group.
@required {groupId: any # ID of the group.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/Members/Approve/{membershipType}/{membershipId}/
@desc Approve the given membershipId to join the group/clan as long as they have applied.
@required {groupId: any # ID of the group., membershipId: any # The membership id being approved., membershipType: any # Membership type of the supplied membership ID.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/Members/DenyList/
@desc Deny all of the pending users for the given group that match the passed-in .
@required {groupId: any # ID of the group.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /GroupV2/User/{membershipType}/{membershipId}/{filter}/{groupType}/
@desc Get information about the groups that a given member has joined.
@required {filter: any # Filter apply to list of joined groups., groupType: any # Type of group the supplied member founded., membershipId: any # Membership ID to for which to find founded groups., membershipType: any # Membership type of the supplied membership ID.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /GroupV2/Recover/{membershipType}/{membershipId}/{groupType}/
@desc Allows a founder to manually recover a group they can see in game but not on bungie.net
@required {groupType: any # Type of group the supplied member founded., membershipId: any # Membership ID to for which to find founded groups., membershipType: any # Membership type of the supplied membership ID.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /GroupV2/User/Potential/{membershipType}/{membershipId}/{filter}/{groupType}/
@desc Get information about the groups that a given member has applied to or been invited to.
@required {filter: any # Filter apply to list of potential joined groups., groupType: any # Type of group the supplied member applied., membershipId: any # Membership ID to for which to find applied groups., membershipType: any # Membership type of the supplied membership ID.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/Members/IndividualInvite/{membershipType}/{membershipId}/
@desc Invite a user to join this group.
@required {groupId: any # ID of the group you would like to join., membershipId: any # Membership id of the account being invited., membershipType: any # MembershipType of the account being invited.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /GroupV2/{groupId}/Members/IndividualInviteCancel/{membershipType}/{membershipId}/
@desc Cancels a pending invitation to join a group.
@required {groupId: any # ID of the group you would like to join., membershipId: any # Membership id of the account being cancelled., membershipType: any # MembershipType of the account being cancelled.}
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@group Tokens
@endpoint POST /Tokens/Partner/ForceDropsRepair/
@desc Twitch Drops self-repair function - scans twitch for drops not marked as fulfilled and resyncs them.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Tokens/Partner/ClaimOffer/
@desc Claim a partner offer as the authenticated user.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Tokens/Partner/ApplyMissingOffers/{partnerApplicationId}/{targetBnetMembershipId}/
@desc Apply a partner offer to the targeted user. This endpoint does not claim a new offer, but any already claimed offers will be applied to the game if not already.
@required {partnerApplicationId: any # The partner application identifier., targetBnetMembershipId: any # The bungie.net user to apply missing offers to. If not self, elevated permissions are required.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Tokens/Partner/History/{partnerApplicationId}/{targetBnetMembershipId}/
@desc Returns the partner sku and offer history of the targeted user. Elevated permissions are required to see users that are not yourself.
@required {partnerApplicationId: any # The partner application identifier., targetBnetMembershipId: any # The bungie.net user to apply missing offers to. If not self, elevated permissions are required.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Tokens/Partner/History/{targetBnetMembershipId}/Application/{partnerApplicationId}/
@desc Returns the partner rewards history of the targeted user, both partner offers and Twitch drops.
@required {partnerApplicationId: any # The partner application identifier., targetBnetMembershipId: any # The bungie.net user to return reward history for.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Tokens/Rewards/GetRewardsForUser/{membershipId}/
@desc Returns the bungie rewards for the targeted user.
@required {membershipId: any # bungie.net user membershipId for requested user rewards. If not self, elevated permissions are required.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Tokens/Rewards/GetRewardsForPlatformUser/{membershipId}/{membershipType}/
@desc Returns the bungie rewards for the targeted user when a platform membership Id and Type are used.
@required {membershipId: any # users platform membershipId for requested user rewards. If not self, elevated permissions are required., membershipType: any # The target Destiny 2 membership type.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Tokens/Rewards/BungieRewards/
@desc Returns a list of the current bungie rewards
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@group Destiny2
@endpoint GET /Destiny2/Manifest/
@desc Returns the current version of the manifest as a json object.
@returns(200) DestinyManifest is the external-facing contract for just the properties needed by those calling the Destiny Platform.

@endpoint GET /Destiny2/Manifest/{entityType}/{hashIdentifier}/
@desc Returns the static definition of an entity of the given Type and hash identifier. Examine the API Documentation for the Type Names of entities that have their own definitions. Note that the return type will always *inherit from* DestinyDefinition, but the specific type returned will be the requested entity type if it can be found. Please don't use this as a chatty alternative to the Manifest database if you require large sets of data, but for simple and one-off accesses this should be handy.
@required {entityType: any # The type of entity for whom you would like results. These correspond to the entity's definition contract name. For instance, if you are looking for items, this property should be 'DestinyInventoryItemDefinition'. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is tentatively in final form, but there may be bugs that prevent desirable operation., hashIdentifier: any # The hash identifier for the specific Entity you want returned.}
@returns(200) Provides common properties for destiny definitions.

@endpoint POST /Destiny2/SearchDestinyPlayerByBungieName/{membershipType}/
@desc Returns a list of Destiny memberships given a global Bungie Display Name. This method will hide overridden memberships due to cross save.
@required {membershipType: any # A valid non-BungieNet membership type, or All. Indicates which memberships to return. You probably want this set to All.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/{membershipType}/Profile/{membershipId}/LinkedProfiles/
@desc Returns a summary information about all profiles linked to the requesting membership type/membership ID that have valid Destiny information. The passed-in Membership Type/Membership ID may be a Bungie.Net membership or a Destiny membership. It only returns the minimal amount of data to begin making more substantive requests, but will hopefully serve as a useful alternative to UserServices for people who just care about Destiny data. Note that it will only return linked accounts whose linkages you are allowed to view.
@required {membershipId: any # The ID of the membership whose linked Destiny accounts you want returned. Make sure your membership ID matches its Membership Type: don't pass us a PSN membership ID and the XBox membership type, it's not going to work!, membershipType: any # The type for the membership whose linked Destiny accounts you want returned.}
@optional {getAllMemberships: any # (optional) if set to 'true', all memberships regardless of whether they're obscured by overrides will be returned. Normal privacy restrictions on account linking will still apply no matter what.}
@returns(200) I know what you seek. You seek linked accounts. Found them, you have.
 This contract returns a minimal amount of data about Destiny Accounts that are linked through your Bungie.Net account. We will not return accounts in this response whose

@endpoint GET /Destiny2/{membershipType}/Profile/{destinyMembershipId}/
@desc Returns Destiny Profile information for the supplied membership.
@required {destinyMembershipId: any # Destiny membership ID., membershipType: any # A valid non-BungieNet membership type.}
@optional {components: any # A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType enum for valid components to request. You must request at least one component to receive results.}
@returns(200) The response for GetDestinyProfile, with components for character and item-level data.

@endpoint GET /Destiny2/{membershipType}/Profile/{destinyMembershipId}/Character/{characterId}/
@desc Returns character information for the supplied character.
@required {characterId: any # ID of the character., destinyMembershipId: any # Destiny membership ID., membershipType: any # A valid non-BungieNet membership type.}
@optional {components: any # A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType enum for valid components to request. You must request at least one component to receive results.}
@returns(200) The response contract for GetDestinyCharacter, with components that can be returned for character and item-level data.

@endpoint GET /Destiny2/Clan/{groupId}/WeeklyRewardState/
@desc Returns information on the weekly clan rewards and if the clan has earned them or not. Note that this will always report rewards as not redeemed.
@required {groupId: any # A valid group id of clan.}
@returns(200) Represents a runtime instance of a user's milestone status. Live Milestone data should be combined with DestinyMilestoneDefinition data to show the user a picture of what is available for them to do in the game, and their status in regards to said "things to do." Consider it a big, wonky to-do list, or Advisors 3.0 for those who remember the Destiny 1 API.

@endpoint GET /Destiny2/Clan/ClanBannerDictionary/
@desc Returns the dictionary of values for the Clan Banner
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/{membershipType}/Profile/{destinyMembershipId}/Item/{itemInstanceId}/
@desc Retrieve the details of an instanced Destiny Item. An instanced Destiny item is one with an ItemInstanceId. Non-instanced items, such as materials, have no useful instance-specific details and thus are not queryable here.
@required {destinyMembershipId: any # The membership ID of the destiny profile., itemInstanceId: any # The Instance ID of the destiny item., membershipType: any # A valid non-BungieNet membership type.}
@optional {components: any # A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType enum for valid components to request. You must request at least one component to receive results.}
@returns(200) The response object for retrieving an individual instanced item. None of these components are relevant for an item that doesn't have an "itemInstanceId": for those, get your information from the DestinyInventoryDefinition.

@endpoint GET /Destiny2/{membershipType}/Profile/{destinyMembershipId}/Character/{characterId}/Vendors/
@desc Get currently available vendors from the list of vendors that can possibly have rotating inventory. Note that this does not include things like preview vendors and vendors-as-kiosks, neither of whom have rotating/dynamic inventories. Use their definitions as-is for those.
@required {characterId: any # The Destiny Character ID of the character for whom we're getting vendor info., destinyMembershipId: any # Destiny membership ID of another user. You may be denied., membershipType: any # A valid non-BungieNet membership type.}
@optional {components: any # A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType enum for valid components to request. You must request at least one component to receive results., filter: any # The filter of what vendors and items to return, if any.}
@returns(200) A response containing all of the components for all requested vendors.

@endpoint GET /Destiny2/{membershipType}/Profile/{destinyMembershipId}/Character/{characterId}/Vendors/{vendorHash}/
@desc Get the details of a specific Vendor.
@required {characterId: any # The Destiny Character ID of the character for whom we're getting vendor info., destinyMembershipId: any # Destiny membership ID of another user. You may be denied., membershipType: any # A valid non-BungieNet membership type., vendorHash: any # The Hash identifier of the Vendor to be returned.}
@optional {components: any # A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType enum for valid components to request. You must request at least one component to receive results.}
@returns(200) A response containing all of the components for a vendor.

@endpoint GET /Destiny2/Vendors/
@desc Get items available from vendors where the vendors have items for sale that are common for everyone. If any portion of the Vendor's available inventory is character or account specific, we will be unable to return their data from this endpoint due to the way that available inventory is computed. As I am often guilty of saying: 'It's a long story...'
@optional {components: any # A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType enum for valid components to request. You must request at least one component to receive results.}
@returns(200) A response containing all valid components for the public Vendors endpoint.
  It is a decisively smaller subset of data compared to what we can get when we know the specific user making the request.
  If you want any of the other data - item details, whether or not you can buy it, etc... you'll have to call in the context of a character. I know, sad but true.

@endpoint GET /Destiny2/{membershipType}/Profile/{destinyMembershipId}/Character/{characterId}/Collectibles/{collectiblePresentationNodeHash}/
@desc Given a Presentation Node that has Collectibles as direct descendants, this will return item details about those descendants in the context of the requesting character.
@required {characterId: any # The Destiny Character ID of the character for whom we're getting collectible detail info., collectiblePresentationNodeHash: any # The hash identifier of the Presentation Node for whom we should return collectible details. Details will only be returned for collectibles that are direct descendants of this node., destinyMembershipId: any # Destiny membership ID of another user. You may be denied., membershipType: any # A valid non-BungieNet membership type.}
@optional {components: any # A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType enum for valid components to request. You must request at least one component to receive results.}
@returns(200) Returns the detailed information about a Collectible Presentation Node and any Collectibles that are direct descendants.

@endpoint POST /Destiny2/Actions/Items/TransferItem/
@desc Transfer an item to/from your vault. You must have a valid Destiny account. You must also pass BOTH a reference AND an instance ID if it's an instanced item. itshappening.gif
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Destiny2/Actions/Items/PullFromPostmaster/
@desc Extract an item from the Postmaster, with whatever implications that may entail. You must have a valid Destiny account. You must also pass BOTH a reference AND an instance ID if it's an instanced item.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Destiny2/Actions/Items/EquipItem/
@desc Equip an item. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Destiny2/Actions/Items/EquipItems/
@desc Equip a list of items by itemInstanceIds. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline. Any items not found on your character will be ignored.
@returns(200) The results of a bulk Equipping operation performed through the Destiny API.

@endpoint POST /Destiny2/Actions/Loadouts/EquipLoadout/
@desc Equip a loadout. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Destiny2/Actions/Loadouts/SnapshotLoadout/
@desc Snapshot a loadout with the currently equipped items.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Destiny2/Actions/Loadouts/UpdateLoadoutIdentifiers/
@desc Update the color, icon, and name of a loadout.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Destiny2/Actions/Loadouts/ClearLoadout/
@desc Clear the identifiers and items of a loadout.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Destiny2/Actions/Items/SetLockState/
@desc Set the Lock State for an instanced item. You must have a valid Destiny Account.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Destiny2/Actions/Items/SetTrackedState/
@desc Set the Tracking State for an instanced item, if that item is a Quest or Bounty. You must have a valid Destiny Account. Yeah, it's an item.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Destiny2/Actions/Items/InsertSocketPlug/
@desc Insert a plug into a socketed item. I know how it sounds, but I assure you it's much more G-rated than you might be guessing. We haven't decided yet whether this will be able to insert plugs that have side effects, but if we do it will require special scope permission for an application attempting to do so. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline. Request must include proof of permission for 'InsertPlugs' from the account owner.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Destiny2/Actions/Items/InsertSocketPlugFree/
@desc Insert a 'free' plug into an item's socket. This does not require 'Advanced Write Action' authorization and is available to 3rd-party apps, but will only work on 'free and reversible' socket actions (Perks, Armor Mods, Shaders, Ornaments, etc.). You must have a valid Destiny Account, and the character must either be in a social space, in orbit, or offline.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/Stats/PostGameCarnageReport/{activityId}/
@desc Gets the available post game carnage report for the activity ID.
@required {activityId: any # The ID of the activity whose PGCR is requested.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Destiny2/Stats/PostGameCarnageReport/{activityId}/Report/
@desc Report a player that you met in an activity that was engaging in ToS-violating activities. Both you and the offending player must have played in the activityId passed in. Please use this judiciously and only when you have strong suspicions of violation, pretty please.
@required {activityId: any # The ID of the activity where you ran into the brigand that you're reporting.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/Stats/Definition/
@desc Gets historical stats definitions.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/Stats/Leaderboards/Clans/{groupId}/
@desc Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.
@required {groupId: any # Group ID of the clan whose leaderboards you wish to fetch.}
@optional {maxtop: any # Maximum number of top players to return. Use a large number to get entire leaderboard., modes: any # List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited., statid: any # ID of stat to return rather than returning all Leaderboard stats.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/Stats/AggregateClanStats/{groupId}/
@desc Gets aggregated stats for a clan using the same categories as the clan leaderboards. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.
@required {groupId: any # Group ID of the clan whose leaderboards you wish to fetch.}
@optional {modes: any # List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/{membershipType}/Account/{destinyMembershipId}/Stats/Leaderboards/
@desc Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint has not yet been implemented. It is being returned for a preview of future functionality, and for public comment/suggestion/preparation.
@required {destinyMembershipId: any # The Destiny membershipId of the user to retrieve., membershipType: any # A valid non-BungieNet membership type.}
@optional {maxtop: any # Maximum number of top players to return. Use a large number to get entire leaderboard., modes: any # List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited., statid: any # ID of stat to return rather than returning all Leaderboard stats.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/Stats/Leaderboards/{membershipType}/{destinyMembershipId}/{characterId}/
@desc Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.
@required {characterId: any # The specific character to build the leaderboard around for the provided Destiny Membership., destinyMembershipId: any # The Destiny membershipId of the user to retrieve., membershipType: any # A valid non-BungieNet membership type.}
@optional {maxtop: any # Maximum number of top players to return. Use a large number to get entire leaderboard., modes: any # List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited., statid: any # ID of stat to return rather than returning all Leaderboard stats.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/Armory/Search/{type}/{searchTerm}/
@desc Gets a page list of Destiny items.
@required {searchTerm: any # The string to use when searching for Destiny entities., type: any # The type of entity for whom you would like results. These correspond to the entity's definition contract name. For instance, if you are looking for items, this property should be 'DestinyInventoryItemDefinition'.}
@optional {page: any # Page number to return, starting with 0.}
@returns(200) The results of a search for Destiny content. This will be improved on over time, I've been doing some experimenting to see what might be useful.

@endpoint GET /Destiny2/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Stats/
@desc Gets historical stats for indicated character.
@required {characterId: any # The id of the character to retrieve. You can omit this character ID or set it to 0 to get aggregate stats across all characters., destinyMembershipId: any # The Destiny membershipId of the user to retrieve., membershipType: any # A valid non-BungieNet membership type.}
@optional {dayend: any # Last day to return when daily stats are requested. Use the format YYYY-MM-DD. Currently, we cannot allow more than 31 days of daily data to be requested in a single request., daystart: any # First day to return when daily stats are requested. Use the format YYYY-MM-DD. Currently, we cannot allow more than 31 days of daily data to be requested in a single request., groups: any # Group of stats to include, otherwise only general stats are returned. Comma separated list is allowed. Values: General, Weapons, Medals, modes: any # Game modes to return. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited., periodType: any # Indicates a specific period type to return. Optional. May be: Daily, AllTime, or Activity}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/{membershipType}/Account/{destinyMembershipId}/Stats/
@desc Gets aggregate historical stats organized around each character for a given account.
@required {destinyMembershipId: any # The Destiny membershipId of the user to retrieve., membershipType: any # A valid non-BungieNet membership type.}
@optional {groups: any # Groups of stats to include, otherwise only general stats are returned. Comma separated list is allowed. Values: General, Weapons, Medals.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Stats/Activities/
@desc Gets activity history stats for indicated character.
@required {characterId: any # The id of the character to retrieve., destinyMembershipId: any # The Destiny membershipId of the user to retrieve., membershipType: any # A valid non-BungieNet membership type.}
@optional {count: any # Number of rows to return, mode: any # A filter for the activity mode to be returned. None returns all activities. See the documentation for DestinyActivityModeType for valid values, and pass in string representation., page: any # Page number to return, starting with 0.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Stats/UniqueWeapons/
@desc Gets details about unique weapon usage, including all exotic weapons.
@required {characterId: any # The id of the character to retrieve., destinyMembershipId: any # The Destiny membershipId of the user to retrieve., membershipType: any # A valid non-BungieNet membership type.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Stats/AggregateActivityStats/
@desc Gets all activities the character has participated in together with aggregate statistics for those activities.
@required {characterId: any # The specific character whose activities should be returned., destinyMembershipId: any # The Destiny membershipId of the user to retrieve., membershipType: any # A valid non-BungieNet membership type.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/Milestones/{milestoneHash}/Content/
@desc Gets custom localized content for the milestone of the given hash, if it exists.
@required {milestoneHash: any # The identifier for the milestone to be returned.}
@returns(200) Represents localized, extended content related to Milestones. This is intentionally returned by a separate endpoint and not with Character-level Milestone data because we do not put localized data into standard Destiny responses, both for brevity of response and for caching purposes. If you really need this data, hit the Milestone Content endpoint.

@endpoint GET /Destiny2/Milestones/
@desc Gets public information about currently available Milestones.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Destiny2/Awa/Initialize/
@desc Initialize a request to perform an advanced write action.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Destiny2/Awa/AwaProvideAuthorizationResult/
@desc Provide the result of the user interaction. Called by the Bungie Destiny App to approve or reject a request.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Destiny2/Awa/GetActionToken/{correlationId}/
@desc Returns the action token if user approves the request.
@required {correlationId: any # The identifier for the advanced write action request.}
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@group CommunityContent
@endpoint GET /CommunityContent/Get/{sort}/{mediaFilter}/{page}/
@desc Returns community content.
@required {mediaFilter: any # The type of media to get, page: any # Zero based page, sort: any # The sort mode.}
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@group Trending
@endpoint GET /Trending/Categories/
@desc Returns trending items for Bungie.net, collapsed into the first page of items per category. For pagination within a category, call GetTrendingCategory.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Trending/Categories/{categoryId}/{pageNumber}/
@desc Returns paginated lists of trending items for a category.
@required {categoryId: any # The ID of the category for whom you want additional results., pageNumber: any # The page # of results to return.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Trending/Details/{trendingEntryType}/{identifier}/
@desc Returns the detailed results for a specific trending entry. Note that trending entries are uniquely identified by a combination of *both* the TrendingEntryType *and* the identifier: the identifier alone is not guaranteed to be globally unique.
@required {identifier: any # The identifier for the entity to be returned., trendingEntryType: any # The type of entity to be returned.}
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@group Fireteam
@endpoint GET /Fireteam/Clan/{groupId}/ActiveCount/
@desc Gets a count of all active non-public fireteams for the specified clan. Maximum value returned is 25.
@required {groupId: any # The group id of the clan.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Fireteam/Clan/{groupId}/Available/{platform}/{activityType}/{dateRange}/{slotFilter}/{publicOnly}/{page}/
@desc Gets a listing of all of this clan's fireteams that are have available slots. Caller is not checked for join criteria so caching is maximized.
@required {activityType: any # The activity type to filter by., dateRange: any # The date range to grab available fireteams., groupId: any # The group id of the clan., page: any # Zero based page, platform: any # The platform filter., publicOnly: any # Determines public/private filtering., slotFilter: any # Filters based on available slots}
@optional {excludeImmediate: any # If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum., langFilter: any # An optional language filter.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Fireteam/Search/Available/{platform}/{activityType}/{dateRange}/{slotFilter}/{page}/
@desc Gets a listing of all public fireteams starting now with open slots. Caller is not checked for join criteria so caching is maximized.
@required {activityType: any # The activity type to filter by., dateRange: any # The date range to grab available fireteams., page: any # Zero based page, platform: any # The platform filter., slotFilter: any # Filters based on available slots}
@optional {excludeImmediate: any # If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum., langFilter: any # An optional language filter.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Fireteam/Clan/{groupId}/My/{platform}/{includeClosed}/{page}/
@desc Gets a listing of all fireteams that caller is an applicant, a member, or an alternate of.
@required {groupId: any # The group id of the clan. (This parameter is ignored unless the optional query parameter groupFilter is true)., includeClosed: any # If true, return fireteams that have been closed., page: any # Deprecated parameter, ignored., platform: any # The platform filter.}
@optional {groupFilter: any # If true, filter by clan. Otherwise, ignore the clan and show all of the user's fireteams., langFilter: any # An optional language filter.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Fireteam/Clan/{groupId}/Summary/{fireteamId}/
@desc Gets a specific fireteam.
@required {fireteamId: any # The unique id of the fireteam., groupId: any # The group id of the clan.}
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@group Social
@endpoint GET /Social/Friends/
@desc Returns your Bungie Friend list
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Social/Friends/Requests/
@desc Returns your friend request queue.
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Social/Friends/Add/{membershipId}/
@desc Requests a friend relationship with the target user. Any of the target user's linked membership ids are valid inputs.
@required {membershipId: any # The membership id of the user you wish to add.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Social/Friends/Requests/Accept/{membershipId}/
@desc Accepts a friend relationship with the target user. The user must be on your incoming friend request list, though no error will occur if they are not.
@required {membershipId: any # The membership id of the user you wish to accept.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Social/Friends/Requests/Decline/{membershipId}/
@desc Declines a friend relationship with the target user. The user must be on your incoming friend request list, though no error will occur if they are not.
@required {membershipId: any # The membership id of the user you wish to decline.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Social/Friends/Remove/{membershipId}/
@desc Remove a friend relationship with the target user. The user must be on your friend list, though no error will occur if they are not.
@required {membershipId: any # The membership id of the user you wish to remove.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint POST /Social/Friends/Requests/Remove/{membershipId}/
@desc Remove a friend relationship with the target user. The user must be on your outgoing request friend list, though no error will occur if they are not.
@required {membershipId: any # The membership id of the user you wish to remove.}
@returns(200) Look at the Response property for more information about the nature of this response

@endpoint GET /Social/PlatformFriends/{friendPlatform}/{page}/
@desc Gets the platform friend of the requested type, with additional information if they have Bungie accounts. Must have a recent login session with said platform.
@required {friendPlatform: any # The platform friend type., page: any # The zero based page to return. Page size is 100.}
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@group GetAvailableLocales
@endpoint GET /GetAvailableLocales/
@desc List of available localization cultures
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@group Settings
@endpoint GET /Settings/
@desc Get the common settings used by the Bungie.Net environment.
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@group UserSystemOverrides
@endpoint GET /UserSystemOverrides/
@desc Get the user-specific system overrides that should be respected alongside common systems.
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@group GlobalAlerts
@endpoint GET /GlobalAlerts/
@desc Gets any active global alert for display in the forum banners, help pages, etc. Usually used for DOC alerts.
@optional {includestreaming: any # Determines whether Streaming Alerts are included in results}
@returns(200) Look at the Response property for more information about the nature of this response

@endgroup

@end