Name | Description | Type | Additional information |
---|---|---|---|
AllowMemberCreatedEvents |
Whether or not members of this community can create events |
boolean |
None. |
AllowTickets |
Whether or not the community is set up to send threads to support documentation |
boolean |
None. |
ThreadTypes |
Specifies the types of threads allowed in the community. A community can have no thread types, but can also have multiple. The possible options currently are "Discussion" and "QAndA" with more types possible in the future. Will be empty if no thread types can be created in the community. |
Collection of string |
None. |
CanMembersInviteOthers |
Whether or not regular community members can invite others on the site |
boolean |
None. |
CommunityKey |
The unique identifier associated to a community throughout the api/site |
globally unique identifier |
None. |
LegacyGroupKey |
Unique Identifier for this Community in the source/ams system. |
string |
None. |
CommunityName |
The name of the community |
string |
None. |
CommunitySize |
The number of members in the community |
integer |
None. |
CommunityTypeKey |
The unique identifier of the inherited community type |
globally unique identifier |
None. |
CommunityType |
Deprecated: use CommunityTypeName |
string |
None. |
CommunityTypeName |
The name of the community type, which this community inherits properties from |
string |
None. |
CreatedByContactKey |
The unique identifier of the contact who created the community |
globally unique identifier |
None. |
CreatedOn |
The date that this community was created |
date |
None. |
Description |
The plain text description, which provides context for the purpose of the community |
string |
None. |
Html |
The html description, which can provide advanced context for the purpose of the community |
string |
None. |
IsTopicCommunity |
Whether or not the community is based around specific topics. These topic based communities require topics to be applied to content created within the community. The set of available topics is included in the TopicTagGroups property |
boolean |
None. |
IsSubscribedToDiscussion |
Whether or not the user is subscribed to the community/discussion. Being subscribed generally allows the users to participate in the community. |
boolean |
None. |
IsOnCommunitySync |
Whether or not the community is currently being processed through our backend sync. |
boolean |
None. |
JoinPermissionKey |
The unique identifier of the join permissions for the community. Generally the permission possibilities line up with the unique identifier for authenticated, members of the site, or invitation only. |
globally unique identifier |
None. |
LibraryKey |
The unique identifier for the library whose content is specific to this community. If no library exists, then this will be an empty guid. |
globally unique identifier |
None. |
LibraryName |
If a library exists for a community, then this is the name specific to the library within the community. |
string |
None. |
LinkToCommunity |
A url that will navigate a user to the community home page on the website |
string |
None. |
LinkToCommunityCalendar |
If the community has events specific to it, then this will return a url that allows the user to navigate to the events calendar specific to the community. |
string |
None. |
LinkToDiscussion |
If the community has a discussion, this will return a url that should navigate a user to the list of threads within the community. |
string |
None. |
LinkToLibrary |
If the community has a library, this will return a url that navigates a user to the library specific to this community. |
string |
None. |
LinkToWebsite |
If the community is related to a specific microsite, this will return a url that navigates the user to the microsite associated to this community. |
string |
None. |
DiscussionKey |
The unique identifier of the discussion, which holds both messages on the site as well as Q&A threads depending on which content types the community allows. This unique identifier is also referred to as an eGroupKey or a listKey throughout the documentation. |
globally unique identifier |
None. |
DiscussionName |
The name of the discussion that holds the message or Q&A thread content on the site. The community name is more often used than the discussion name. |
string |
None. |
MicrositeGroupKey |
If the community is associated to a specific microsite, then this will return a uniqueidentifier that refers to the micrositeGroup, which contains the microsite associated to this community. |
globally unique identifier |
None. |
SiteName |
If the community is associated to a microsite, this refers to the name of the microsite. |
string |
None. |
ViewPermissionKey |
The unique identifier associated to the grouping of users that can view the community on the site. This generally corresponds to Public, Invitation Only, Site Members, or Public. This doesn't relate directly to the view permissions of the content within the community, but instead the community itself. |
globally unique identifier |
None. |
Statistics |
A set of community specific statistics to give more in depth information/reporting for the community. |
CommunityStatistics |
None. |
CreatedByContact |
The contact information for the user who originally created the community. |
ContactConcise |
None. |
IntegrationKey |
Community unique identifier as represented in the ams/source data. |
string |
None. |
IntegrationTypeKey |
Community Type unique identifier as represented in the ams/source data. |
string |
None. |
ParentCommunityKey |
If the community is nested with a parent community, this will be the unique identifier of that parent community. Otherwise this will return an empty guid. |
globally unique identifier |
None. |
TopicTagGroups |
If this community is a topic community, this provides the set of valid topic tags and their respective unique identifiers. Otherwise this will be empty. |
Collection of TopicTagGroup |
None. |