GET api/v2.0/Communities/GetCommunitiesICanJoin?includeStatistics={includeStatistics}
Returns a list of Communities the Current User is not a member of, but is eligible to join.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
includeStatistics |
Defaults to False. Set True to include counts and other extra statistics about the Communities. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of CommunityName | Description | Type | Additional information |
---|---|---|---|
AllowMemberCreatedEvents | boolean |
None. |
|
AllowTickets | boolean |
None. |
|
CanMembersInviteOthers | boolean |
None. |
|
CommunityKey | globally unique identifier |
None. |
|
LegacyGroupKey |
Unique Identifier for this Community in the source system. |
string |
None. |
CommunityName | string |
None. |
|
CommunitySize | integer |
None. |
|
CommunityType | string |
None. |
|
CommunityTypeKey | globally unique identifier |
None. |
|
CommunityTypeName | string |
None. |
|
CreatedByContactKey | globally unique identifier |
None. |
|
CreatedOn | date |
None. |
|
Description | string |
None. |
|
Html | string |
None. |
|
IsSubscribedToDiscussion | boolean |
None. |
|
IsOnCommunitySync | boolean |
None. |
|
JoinPermissionKey | globally unique identifier |
None. |
|
LibraryKey | globally unique identifier |
None. |
|
LibraryName | string |
None. |
|
LinkToCommunity | string |
None. |
|
LinkToCommunityCalendar | string |
None. |
|
LinkToDiscussion | string |
None. |
|
LinkToLibrary | string |
None. |
|
LinkToWebsite | string |
None. |
|
DiscussionKey | globally unique identifier |
None. |
|
DiscussionName | string |
None. |
|
MicrositeGroupKey | globally unique identifier |
None. |
|
SiteName | string |
None. |
|
ViewPermissionKey | globally unique identifier |
None. |
|
Statistics | CommunityStatistics |
None. |
|
CreatedByContact | ContactConcise |
None. |
|
IntegrationKey |
Community Key as represented in the source data. |
string |
None. |
IntegrationTypeKey |
Community Type Key as represented in the source data. |
string |
None. |
ParentCommunityKey | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[ { "AllowMemberCreatedEvents": true, "AllowTickets": true, "CanMembersInviteOthers": true, "CommunityKey": "2b929ca8-49c3-48cd-9243-8a20e281e080", "LegacyGroupKey": "sample string 5", "CommunityName": "sample string 6", "CommunitySize": 7, "CommunityType": "sample string 8", "CommunityTypeKey": "5c8e19f3-5875-4785-bf65-307b5a6decf8", "CommunityTypeName": "sample string 10", "CreatedByContactKey": "5d6a77f0-c521-43a0-93ea-457026fcde0d", "CreatedOn": "2021-01-19T08:33:39.1716729Z", "Description": "sample string 13", "Html": "sample string 14", "IsSubscribedToDiscussion": true, "IsOnCommunitySync": true, "JoinPermissionKey": "c98333fc-37f2-46ab-913f-fee1cb5f8a82", "LibraryKey": "938e2751-0f88-4528-a202-7e83e92ec6dc", "LibraryName": "sample string 19", "LinkToCommunity": "sample string 20", "LinkToCommunityCalendar": "sample string 21", "LinkToDiscussion": "sample string 22", "LinkToLibrary": "sample string 23", "LinkToWebsite": "sample string 24", "DiscussionKey": "739ce16a-b47b-4451-96bb-83f7c49e6f3f", "DiscussionName": "sample string 26", "MicrositeGroupKey": "16e42a01-2ea2-4728-b30e-df9f5d5fc087", "SiteName": "sample string 28", "ViewPermissionKey": "298fd8b6-84a4-4ccf-9f8f-134801d23a96", "Statistics": { "BlogCount": 1, "DocumentCount": 2, "MemberCount": 3, "DiscussionPostCount": 4, "CurrentYearAnnouncementCount": 5, "CurrentYearEventCount": 6, "LastDocumentUpdatedDate": "2021-01-19T08:33:39.1716729Z", "LastMemberJoinedDate": "2021-01-19T08:33:39.1716729Z", "LastPostingDate": "2021-01-19T08:33:39.1716729Z", "LastBlogPublishedDate": "2021-01-19T08:33:39.1716729Z", "LastAnnouncementUpdatedOnDate": "2021-01-19T08:33:39.1716729Z", "LastEventUpdatedOnDate": "2021-01-19T08:33:39.1716729Z", "MaxActivityDate": "2021-01-19T08:33:39.1716729Z", "MinActivityDate": "2021-01-19T08:33:39.1716729Z" }, "CreatedByContact": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "23ad0d3a-d56e-4b35-9fe3-a71573ba519e", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2021-01-19T08:33:39.1716729Z", "UpdatedByContactKey": "7366bd2e-58e6-4233-9a86-0439359b9f83", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2021-01-19T08:33:39.1716729Z" }, "IntegrationKey": "sample string 30", "IntegrationTypeKey": "sample string 31", "ParentCommunityKey": "4e0bab57-b327-4718-83a1-c699ff0bac2b" }, { "AllowMemberCreatedEvents": true, "AllowTickets": true, "CanMembersInviteOthers": true, "CommunityKey": "2b929ca8-49c3-48cd-9243-8a20e281e080", "LegacyGroupKey": "sample string 5", "CommunityName": "sample string 6", "CommunitySize": 7, "CommunityType": "sample string 8", "CommunityTypeKey": "5c8e19f3-5875-4785-bf65-307b5a6decf8", "CommunityTypeName": "sample string 10", "CreatedByContactKey": "5d6a77f0-c521-43a0-93ea-457026fcde0d", "CreatedOn": "2021-01-19T08:33:39.1716729Z", "Description": "sample string 13", "Html": "sample string 14", "IsSubscribedToDiscussion": true, "IsOnCommunitySync": true, "JoinPermissionKey": "c98333fc-37f2-46ab-913f-fee1cb5f8a82", "LibraryKey": "938e2751-0f88-4528-a202-7e83e92ec6dc", "LibraryName": "sample string 19", "LinkToCommunity": "sample string 20", "LinkToCommunityCalendar": "sample string 21", "LinkToDiscussion": "sample string 22", "LinkToLibrary": "sample string 23", "LinkToWebsite": "sample string 24", "DiscussionKey": "739ce16a-b47b-4451-96bb-83f7c49e6f3f", "DiscussionName": "sample string 26", "MicrositeGroupKey": "16e42a01-2ea2-4728-b30e-df9f5d5fc087", "SiteName": "sample string 28", "ViewPermissionKey": "298fd8b6-84a4-4ccf-9f8f-134801d23a96", "Statistics": { "BlogCount": 1, "DocumentCount": 2, "MemberCount": 3, "DiscussionPostCount": 4, "CurrentYearAnnouncementCount": 5, "CurrentYearEventCount": 6, "LastDocumentUpdatedDate": "2021-01-19T08:33:39.1716729Z", "LastMemberJoinedDate": "2021-01-19T08:33:39.1716729Z", "LastPostingDate": "2021-01-19T08:33:39.1716729Z", "LastBlogPublishedDate": "2021-01-19T08:33:39.1716729Z", "LastAnnouncementUpdatedOnDate": "2021-01-19T08:33:39.1716729Z", "LastEventUpdatedOnDate": "2021-01-19T08:33:39.1716729Z", "MaxActivityDate": "2021-01-19T08:33:39.1716729Z", "MinActivityDate": "2021-01-19T08:33:39.1716729Z" }, "CreatedByContact": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "23ad0d3a-d56e-4b35-9fe3-a71573ba519e", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2021-01-19T08:33:39.1716729Z", "UpdatedByContactKey": "7366bd2e-58e6-4233-9a86-0439359b9f83", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2021-01-19T08:33:39.1716729Z" }, "IntegrationKey": "sample string 30", "IntegrationTypeKey": "sample string 31", "ParentCommunityKey": "4e0bab57-b327-4718-83a1-c699ff0bac2b" } ]
application/xml, text/xml
Sample:
<ArrayOfCommunity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise"> <Community> <AllowMemberCreatedEvents>true</AllowMemberCreatedEvents> <AllowTickets>true</AllowTickets> <CanMembersInviteOthers>true</CanMembersInviteOthers> <CommunityKey>2b929ca8-49c3-48cd-9243-8a20e281e080</CommunityKey> <CommunityName>sample string 6</CommunityName> <CommunitySize>7</CommunitySize> <CommunityType>sample string 8</CommunityType> <CommunityTypeKey>5c8e19f3-5875-4785-bf65-307b5a6decf8</CommunityTypeKey> <CommunityTypeName>sample string 10</CommunityTypeName> <CreatedByContact> <AMSDirectoryOptOut>true</AMSDirectoryOptOut> <AgreedToTermsDateTime>2021-01-19T03:33:39.1716729-05:00</AgreedToTermsDateTime> <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey> <CompanyName>sample string 12</CompanyName> <CompanyTitle>sample string 13</CompanyTitle> <ContactKey>23ad0d3a-d56e-4b35-9fe3-a71573ba519e</ContactKey> <ContactStatusCode>sample string 8</ContactStatusCode> <Designation>sample string 15</Designation> <DisplayName>sample string 6</DisplayName> <EmailAddress>sample string 7</EmailAddress> <FirstName>sample string 4</FirstName> <HLContactMeOptOut>true</HLContactMeOptOut> <HLDirectoryOptOut>true</HLDirectoryOptOut> <InformalName>sample string 17</InformalName> <IsCompany>true</IsCompany> <LargePictureUrl>sample string 24</LargePictureUrl> <LastName>sample string 5</LastName> <LegacyContactKey>sample string 16</LegacyContactKey> <LinkToProfile>sample string 1</LinkToProfile> <MiddleName>sample string 18</MiddleName> <PictureUrl>sample string 2</PictureUrl> <PrefixCode>sample string 9</PrefixCode> <SuffixCode>sample string 14</SuffixCode> <UpdatedByContactKey>7366bd2e-58e6-4233-9a86-0439359b9f83</UpdatedByContactKey> <UpdatedOn>2021-01-19T03:33:39.1716729-05:00</UpdatedOn> </CreatedByContact> <CreatedByContactKey>5d6a77f0-c521-43a0-93ea-457026fcde0d</CreatedByContactKey> <CreatedOn>2021-01-19T03:33:39.1716729-05:00</CreatedOn> <Description>sample string 13</Description> <DiscussionKey>739ce16a-b47b-4451-96bb-83f7c49e6f3f</DiscussionKey> <DiscussionName>sample string 26</DiscussionName> <Html>sample string 14</Html> <IntegrationKey>sample string 30</IntegrationKey> <IntegrationTypeKey>sample string 31</IntegrationTypeKey> <IsOnCommunitySync>true</IsOnCommunitySync> <IsSubscribedToDiscussion>true</IsSubscribedToDiscussion> <JoinPermissionKey>c98333fc-37f2-46ab-913f-fee1cb5f8a82</JoinPermissionKey> <LegacyGroupKey>sample string 5</LegacyGroupKey> <LibraryKey>938e2751-0f88-4528-a202-7e83e92ec6dc</LibraryKey> <LibraryName>sample string 19</LibraryName> <LinkToCommunity>sample string 20</LinkToCommunity> <LinkToCommunityCalendar>sample string 21</LinkToCommunityCalendar> <LinkToDiscussion>sample string 22</LinkToDiscussion> <LinkToLibrary>sample string 23</LinkToLibrary> <LinkToWebsite>sample string 24</LinkToWebsite> <MicrositeGroupKey>16e42a01-2ea2-4728-b30e-df9f5d5fc087</MicrositeGroupKey> <SiteName>sample string 28</SiteName> <Statistics> <BlogCount>1</BlogCount> <CurrentYearAnnouncementCount>5</CurrentYearAnnouncementCount> <CurrentYearEventCount>6</CurrentYearEventCount> <DiscussionPostCount>4</DiscussionPostCount> <DocumentCount>2</DocumentCount> <LastAnnouncementUpdatedOnDate>2021-01-19T03:33:39.1716729-05:00</LastAnnouncementUpdatedOnDate> <LastBlogPublishedDate>2021-01-19T03:33:39.1716729-05:00</LastBlogPublishedDate> <LastDocumentUpdatedDate>2021-01-19T03:33:39.1716729-05:00</LastDocumentUpdatedDate> <LastEventUpdatedOnDate>2021-01-19T03:33:39.1716729-05:00</LastEventUpdatedOnDate> <LastMemberJoinedDate>2021-01-19T03:33:39.1716729-05:00</LastMemberJoinedDate> <LastPostingDate>2021-01-19T03:33:39.1716729-05:00</LastPostingDate> <MaxActivityDate>2021-01-19T03:33:39.1716729-05:00</MaxActivityDate> <MemberCount>3</MemberCount> <MinActivityDate>2021-01-19T03:33:39.1716729-05:00</MinActivityDate> </Statistics> <ViewPermissionKey>298fd8b6-84a4-4ccf-9f8f-134801d23a96</ViewPermissionKey> </Community> <Community> <AllowMemberCreatedEvents>true</AllowMemberCreatedEvents> <AllowTickets>true</AllowTickets> <CanMembersInviteOthers>true</CanMembersInviteOthers> <CommunityKey>2b929ca8-49c3-48cd-9243-8a20e281e080</CommunityKey> <CommunityName>sample string 6</CommunityName> <CommunitySize>7</CommunitySize> <CommunityType>sample string 8</CommunityType> <CommunityTypeKey>5c8e19f3-5875-4785-bf65-307b5a6decf8</CommunityTypeKey> <CommunityTypeName>sample string 10</CommunityTypeName> <CreatedByContact> <AMSDirectoryOptOut>true</AMSDirectoryOptOut> <AgreedToTermsDateTime>2021-01-19T03:33:39.1716729-05:00</AgreedToTermsDateTime> <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey> <CompanyName>sample string 12</CompanyName> <CompanyTitle>sample string 13</CompanyTitle> <ContactKey>23ad0d3a-d56e-4b35-9fe3-a71573ba519e</ContactKey> <ContactStatusCode>sample string 8</ContactStatusCode> <Designation>sample string 15</Designation> <DisplayName>sample string 6</DisplayName> <EmailAddress>sample string 7</EmailAddress> <FirstName>sample string 4</FirstName> <HLContactMeOptOut>true</HLContactMeOptOut> <HLDirectoryOptOut>true</HLDirectoryOptOut> <InformalName>sample string 17</InformalName> <IsCompany>true</IsCompany> <LargePictureUrl>sample string 24</LargePictureUrl> <LastName>sample string 5</LastName> <LegacyContactKey>sample string 16</LegacyContactKey> <LinkToProfile>sample string 1</LinkToProfile> <MiddleName>sample string 18</MiddleName> <PictureUrl>sample string 2</PictureUrl> <PrefixCode>sample string 9</PrefixCode> <SuffixCode>sample string 14</SuffixCode> <UpdatedByContactKey>7366bd2e-58e6-4233-9a86-0439359b9f83</UpdatedByContactKey> <UpdatedOn>2021-01-19T03:33:39.1716729-05:00</UpdatedOn> </CreatedByContact> <CreatedByContactKey>5d6a77f0-c521-43a0-93ea-457026fcde0d</CreatedByContactKey> <CreatedOn>2021-01-19T03:33:39.1716729-05:00</CreatedOn> <Description>sample string 13</Description> <DiscussionKey>739ce16a-b47b-4451-96bb-83f7c49e6f3f</DiscussionKey> <DiscussionName>sample string 26</DiscussionName> <Html>sample string 14</Html> <IntegrationKey>sample string 30</IntegrationKey> <IntegrationTypeKey>sample string 31</IntegrationTypeKey> <IsOnCommunitySync>true</IsOnCommunitySync> <IsSubscribedToDiscussion>true</IsSubscribedToDiscussion> <JoinPermissionKey>c98333fc-37f2-46ab-913f-fee1cb5f8a82</JoinPermissionKey> <LegacyGroupKey>sample string 5</LegacyGroupKey> <LibraryKey>938e2751-0f88-4528-a202-7e83e92ec6dc</LibraryKey> <LibraryName>sample string 19</LibraryName> <LinkToCommunity>sample string 20</LinkToCommunity> <LinkToCommunityCalendar>sample string 21</LinkToCommunityCalendar> <LinkToDiscussion>sample string 22</LinkToDiscussion> <LinkToLibrary>sample string 23</LinkToLibrary> <LinkToWebsite>sample string 24</LinkToWebsite> <MicrositeGroupKey>16e42a01-2ea2-4728-b30e-df9f5d5fc087</MicrositeGroupKey> <SiteName>sample string 28</SiteName> <Statistics> <BlogCount>1</BlogCount> <CurrentYearAnnouncementCount>5</CurrentYearAnnouncementCount> <CurrentYearEventCount>6</CurrentYearEventCount> <DiscussionPostCount>4</DiscussionPostCount> <DocumentCount>2</DocumentCount> <LastAnnouncementUpdatedOnDate>2021-01-19T03:33:39.1716729-05:00</LastAnnouncementUpdatedOnDate> <LastBlogPublishedDate>2021-01-19T03:33:39.1716729-05:00</LastBlogPublishedDate> <LastDocumentUpdatedDate>2021-01-19T03:33:39.1716729-05:00</LastDocumentUpdatedDate> <LastEventUpdatedOnDate>2021-01-19T03:33:39.1716729-05:00</LastEventUpdatedOnDate> <LastMemberJoinedDate>2021-01-19T03:33:39.1716729-05:00</LastMemberJoinedDate> <LastPostingDate>2021-01-19T03:33:39.1716729-05:00</LastPostingDate> <MaxActivityDate>2021-01-19T03:33:39.1716729-05:00</MaxActivityDate> <MemberCount>3</MemberCount> <MinActivityDate>2021-01-19T03:33:39.1716729-05:00</MinActivityDate> </Statistics> <ViewPermissionKey>298fd8b6-84a4-4ccf-9f8f-134801d23a96</ViewPermissionKey> </Community> </ArrayOfCommunity>