GET api/v2.0/Communities/GetContactCommunities?contactKey={contactKey}&legacyContactKey={legacyContactKey}
Administrator-only endpoint. Returns a list of the specified User's joined Communities. If both a ContactKey and LegacyContactKey are specified, the ContactKey will be used. If neither parameter is specified, an error will be returned.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
contactKey |
The Unique Contact Key of a user. |
globally unique identifier |
None. |
legacyContactKey |
The Unique Source System Key of a user. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
List of Community Object data.
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": "d2a2848a-f9d1-4c75-892f-49d79be03ff4", "LegacyGroupKey": "sample string 5", "CommunityName": "sample string 6", "CommunitySize": 7, "CommunityType": "sample string 8", "CommunityTypeKey": "0b5a4dd3-91d8-40ce-ab8f-049b8fede6d8", "CommunityTypeName": "sample string 10", "CreatedByContactKey": "e360bf86-a1d7-4179-9cae-411f94d45bf4", "CreatedOn": "2021-01-19T08:33:37.1731925Z", "Description": "sample string 13", "Html": "sample string 14", "IsSubscribedToDiscussion": true, "IsOnCommunitySync": true, "JoinPermissionKey": "5693632d-7a11-405a-a66d-04ade18b2f3d", "LibraryKey": "321d6f9f-a021-473d-85cd-a366cbc9dfd0", "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": "1b6d22f4-8b57-4965-b461-d2964ff977f1", "DiscussionName": "sample string 26", "MicrositeGroupKey": "846652ba-21e5-48d6-b5e5-6ab7232efb02", "SiteName": "sample string 28", "ViewPermissionKey": "74d4c211-c612-4516-adb4-39b238c29cfc", "Statistics": { "BlogCount": 1, "DocumentCount": 2, "MemberCount": 3, "DiscussionPostCount": 4, "CurrentYearAnnouncementCount": 5, "CurrentYearEventCount": 6, "LastDocumentUpdatedDate": "2021-01-19T08:33:37.1731925Z", "LastMemberJoinedDate": "2021-01-19T08:33:37.1731925Z", "LastPostingDate": "2021-01-19T08:33:37.1731925Z", "LastBlogPublishedDate": "2021-01-19T08:33:37.1731925Z", "LastAnnouncementUpdatedOnDate": "2021-01-19T08:33:37.1731925Z", "LastEventUpdatedOnDate": "2021-01-19T08:33:37.1731925Z", "MaxActivityDate": "2021-01-19T08:33:37.1731925Z", "MinActivityDate": "2021-01-19T08:33:37.1731925Z" }, "CreatedByContact": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "d10537ff-7e2c-4e8e-82e4-b9926b17ddee", "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:37.1731925Z", "UpdatedByContactKey": "34829bac-d16b-4209-8dab-062c42578162", "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:37.1731925Z" }, "IntegrationKey": "sample string 30", "IntegrationTypeKey": "sample string 31", "ParentCommunityKey": "725e2991-9a9c-4526-b423-c5f7387cef96" }, { "AllowMemberCreatedEvents": true, "AllowTickets": true, "CanMembersInviteOthers": true, "CommunityKey": "d2a2848a-f9d1-4c75-892f-49d79be03ff4", "LegacyGroupKey": "sample string 5", "CommunityName": "sample string 6", "CommunitySize": 7, "CommunityType": "sample string 8", "CommunityTypeKey": "0b5a4dd3-91d8-40ce-ab8f-049b8fede6d8", "CommunityTypeName": "sample string 10", "CreatedByContactKey": "e360bf86-a1d7-4179-9cae-411f94d45bf4", "CreatedOn": "2021-01-19T08:33:37.1731925Z", "Description": "sample string 13", "Html": "sample string 14", "IsSubscribedToDiscussion": true, "IsOnCommunitySync": true, "JoinPermissionKey": "5693632d-7a11-405a-a66d-04ade18b2f3d", "LibraryKey": "321d6f9f-a021-473d-85cd-a366cbc9dfd0", "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": "1b6d22f4-8b57-4965-b461-d2964ff977f1", "DiscussionName": "sample string 26", "MicrositeGroupKey": "846652ba-21e5-48d6-b5e5-6ab7232efb02", "SiteName": "sample string 28", "ViewPermissionKey": "74d4c211-c612-4516-adb4-39b238c29cfc", "Statistics": { "BlogCount": 1, "DocumentCount": 2, "MemberCount": 3, "DiscussionPostCount": 4, "CurrentYearAnnouncementCount": 5, "CurrentYearEventCount": 6, "LastDocumentUpdatedDate": "2021-01-19T08:33:37.1731925Z", "LastMemberJoinedDate": "2021-01-19T08:33:37.1731925Z", "LastPostingDate": "2021-01-19T08:33:37.1731925Z", "LastBlogPublishedDate": "2021-01-19T08:33:37.1731925Z", "LastAnnouncementUpdatedOnDate": "2021-01-19T08:33:37.1731925Z", "LastEventUpdatedOnDate": "2021-01-19T08:33:37.1731925Z", "MaxActivityDate": "2021-01-19T08:33:37.1731925Z", "MinActivityDate": "2021-01-19T08:33:37.1731925Z" }, "CreatedByContact": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "d10537ff-7e2c-4e8e-82e4-b9926b17ddee", "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:37.1731925Z", "UpdatedByContactKey": "34829bac-d16b-4209-8dab-062c42578162", "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:37.1731925Z" }, "IntegrationKey": "sample string 30", "IntegrationTypeKey": "sample string 31", "ParentCommunityKey": "725e2991-9a9c-4526-b423-c5f7387cef96" } ]
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>d2a2848a-f9d1-4c75-892f-49d79be03ff4</CommunityKey> <CommunityName>sample string 6</CommunityName> <CommunitySize>7</CommunitySize> <CommunityType>sample string 8</CommunityType> <CommunityTypeKey>0b5a4dd3-91d8-40ce-ab8f-049b8fede6d8</CommunityTypeKey> <CommunityTypeName>sample string 10</CommunityTypeName> <CreatedByContact> <AMSDirectoryOptOut>true</AMSDirectoryOptOut> <AgreedToTermsDateTime>2021-01-19T03:33:37.1731925-05:00</AgreedToTermsDateTime> <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey> <CompanyName>sample string 12</CompanyName> <CompanyTitle>sample string 13</CompanyTitle> <ContactKey>d10537ff-7e2c-4e8e-82e4-b9926b17ddee</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>34829bac-d16b-4209-8dab-062c42578162</UpdatedByContactKey> <UpdatedOn>2021-01-19T03:33:37.1731925-05:00</UpdatedOn> </CreatedByContact> <CreatedByContactKey>e360bf86-a1d7-4179-9cae-411f94d45bf4</CreatedByContactKey> <CreatedOn>2021-01-19T03:33:37.1731925-05:00</CreatedOn> <Description>sample string 13</Description> <DiscussionKey>1b6d22f4-8b57-4965-b461-d2964ff977f1</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>5693632d-7a11-405a-a66d-04ade18b2f3d</JoinPermissionKey> <LegacyGroupKey>sample string 5</LegacyGroupKey> <LibraryKey>321d6f9f-a021-473d-85cd-a366cbc9dfd0</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>846652ba-21e5-48d6-b5e5-6ab7232efb02</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:37.1731925-05:00</LastAnnouncementUpdatedOnDate> <LastBlogPublishedDate>2021-01-19T03:33:37.1731925-05:00</LastBlogPublishedDate> <LastDocumentUpdatedDate>2021-01-19T03:33:37.1731925-05:00</LastDocumentUpdatedDate> <LastEventUpdatedOnDate>2021-01-19T03:33:37.1731925-05:00</LastEventUpdatedOnDate> <LastMemberJoinedDate>2021-01-19T03:33:37.1731925-05:00</LastMemberJoinedDate> <LastPostingDate>2021-01-19T03:33:37.1731925-05:00</LastPostingDate> <MaxActivityDate>2021-01-19T03:33:37.1731925-05:00</MaxActivityDate> <MemberCount>3</MemberCount> <MinActivityDate>2021-01-19T03:33:37.1731925-05:00</MinActivityDate> </Statistics> <ViewPermissionKey>74d4c211-c612-4516-adb4-39b238c29cfc</ViewPermissionKey> </Community> <Community> <AllowMemberCreatedEvents>true</AllowMemberCreatedEvents> <AllowTickets>true</AllowTickets> <CanMembersInviteOthers>true</CanMembersInviteOthers> <CommunityKey>d2a2848a-f9d1-4c75-892f-49d79be03ff4</CommunityKey> <CommunityName>sample string 6</CommunityName> <CommunitySize>7</CommunitySize> <CommunityType>sample string 8</CommunityType> <CommunityTypeKey>0b5a4dd3-91d8-40ce-ab8f-049b8fede6d8</CommunityTypeKey> <CommunityTypeName>sample string 10</CommunityTypeName> <CreatedByContact> <AMSDirectoryOptOut>true</AMSDirectoryOptOut> <AgreedToTermsDateTime>2021-01-19T03:33:37.1731925-05:00</AgreedToTermsDateTime> <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey> <CompanyName>sample string 12</CompanyName> <CompanyTitle>sample string 13</CompanyTitle> <ContactKey>d10537ff-7e2c-4e8e-82e4-b9926b17ddee</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>34829bac-d16b-4209-8dab-062c42578162</UpdatedByContactKey> <UpdatedOn>2021-01-19T03:33:37.1731925-05:00</UpdatedOn> </CreatedByContact> <CreatedByContactKey>e360bf86-a1d7-4179-9cae-411f94d45bf4</CreatedByContactKey> <CreatedOn>2021-01-19T03:33:37.1731925-05:00</CreatedOn> <Description>sample string 13</Description> <DiscussionKey>1b6d22f4-8b57-4965-b461-d2964ff977f1</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>5693632d-7a11-405a-a66d-04ade18b2f3d</JoinPermissionKey> <LegacyGroupKey>sample string 5</LegacyGroupKey> <LibraryKey>321d6f9f-a021-473d-85cd-a366cbc9dfd0</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>846652ba-21e5-48d6-b5e5-6ab7232efb02</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:37.1731925-05:00</LastAnnouncementUpdatedOnDate> <LastBlogPublishedDate>2021-01-19T03:33:37.1731925-05:00</LastBlogPublishedDate> <LastDocumentUpdatedDate>2021-01-19T03:33:37.1731925-05:00</LastDocumentUpdatedDate> <LastEventUpdatedOnDate>2021-01-19T03:33:37.1731925-05:00</LastEventUpdatedOnDate> <LastMemberJoinedDate>2021-01-19T03:33:37.1731925-05:00</LastMemberJoinedDate> <LastPostingDate>2021-01-19T03:33:37.1731925-05:00</LastPostingDate> <MaxActivityDate>2021-01-19T03:33:37.1731925-05:00</MaxActivityDate> <MemberCount>3</MemberCount> <MinActivityDate>2021-01-19T03:33:37.1731925-05:00</MinActivityDate> </Statistics> <ViewPermissionKey>74d4c211-c612-4516-adb4-39b238c29cfc</ViewPermissionKey> </Community> </ArrayOfCommunity>