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 Community

Name	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": "4aa079d5-7e90-489c-8b00-ef7fde4b7047",
    "LegacyGroupKey": "sample string 5",
    "CommunityName": "sample string 6",
    "CommunitySize": 7,
    "CommunityType": "sample string 8",
    "CommunityTypeKey": "17abe3a7-5ebf-48df-9813-969bf7b456d8",
    "CommunityTypeName": "sample string 10",
    "CreatedByContactKey": "96e44cb5-bee9-4231-a751-937fcb4eb94c",
    "CreatedOn": "2020-04-03T07:18:54.9902056Z",
    "Description": "sample string 13",
    "Html": "sample string 14",
    "IsSubscribedToDiscussion": true,
    "IsOnCommunitySync": true,
    "JoinPermissionKey": "cee2b5e7-6b7f-4f37-b0b8-0daa0fb39c54",
    "LibraryKey": "b20219c2-b6ba-4d11-abab-669df4fff039",
    "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": "4ac103c1-ce0e-47c0-9551-c63e7cc7246f",
    "DiscussionName": "sample string 26",
    "MicrositeGroupKey": "8c861b45-d9aa-4285-9512-38f35afb1106",
    "SiteName": "sample string 28",
    "ViewPermissionKey": "64e6a438-9cc0-47b0-9976-8dd45f27d86e",
    "Statistics": {
      "BlogCount": 1,
      "DocumentCount": 2,
      "MemberCount": 3,
      "DiscussionPostCount": 4,
      "CurrentYearAnnouncementCount": 5,
      "CurrentYearEventCount": 6,
      "LastDocumentUpdatedDate": "2020-04-03T07:18:54.9902056Z",
      "LastMemberJoinedDate": "2020-04-03T07:18:54.9902056Z",
      "LastPostingDate": "2020-04-03T07:18:54.9902056Z",
      "LastBlogPublishedDate": "2020-04-03T07:18:54.9902056Z",
      "LastAnnouncementUpdatedOnDate": "2020-04-03T07:18:54.9902056Z",
      "LastEventUpdatedOnDate": "2020-04-03T07:18:54.9902056Z",
      "MaxActivityDate": "2020-04-03T07:18:54.9902056Z",
      "MinActivityDate": "2020-04-03T07:18:54.9902056Z"
    },
    "CreatedByContact": {
      "LinkToProfile": "sample string 1",
      "PictureUrl": "sample string 2",
      "ContactKey": "243e0cd6-efff-46b7-9c17-52c6bad102b9",
      "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": "2020-04-03T07:18:54.9902056Z",
      "UpdatedByContactKey": "0bc5c8d6-2ddd-4552-9f1a-72ad759332cf",
      "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": "2020-04-03T07:18:54.9902056Z"
    },
    "IntegrationKey": "sample string 30",
    "IntegrationTypeKey": "sample string 31",
    "ParentCommunityKey": "89bde856-1dc0-40e1-9f9d-7b310aade65f"
  },
  {
    "AllowMemberCreatedEvents": true,
    "AllowTickets": true,
    "CanMembersInviteOthers": true,
    "CommunityKey": "4aa079d5-7e90-489c-8b00-ef7fde4b7047",
    "LegacyGroupKey": "sample string 5",
    "CommunityName": "sample string 6",
    "CommunitySize": 7,
    "CommunityType": "sample string 8",
    "CommunityTypeKey": "17abe3a7-5ebf-48df-9813-969bf7b456d8",
    "CommunityTypeName": "sample string 10",
    "CreatedByContactKey": "96e44cb5-bee9-4231-a751-937fcb4eb94c",
    "CreatedOn": "2020-04-03T07:18:54.9902056Z",
    "Description": "sample string 13",
    "Html": "sample string 14",
    "IsSubscribedToDiscussion": true,
    "IsOnCommunitySync": true,
    "JoinPermissionKey": "cee2b5e7-6b7f-4f37-b0b8-0daa0fb39c54",
    "LibraryKey": "b20219c2-b6ba-4d11-abab-669df4fff039",
    "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": "4ac103c1-ce0e-47c0-9551-c63e7cc7246f",
    "DiscussionName": "sample string 26",
    "MicrositeGroupKey": "8c861b45-d9aa-4285-9512-38f35afb1106",
    "SiteName": "sample string 28",
    "ViewPermissionKey": "64e6a438-9cc0-47b0-9976-8dd45f27d86e",
    "Statistics": {
      "BlogCount": 1,
      "DocumentCount": 2,
      "MemberCount": 3,
      "DiscussionPostCount": 4,
      "CurrentYearAnnouncementCount": 5,
      "CurrentYearEventCount": 6,
      "LastDocumentUpdatedDate": "2020-04-03T07:18:54.9902056Z",
      "LastMemberJoinedDate": "2020-04-03T07:18:54.9902056Z",
      "LastPostingDate": "2020-04-03T07:18:54.9902056Z",
      "LastBlogPublishedDate": "2020-04-03T07:18:54.9902056Z",
      "LastAnnouncementUpdatedOnDate": "2020-04-03T07:18:54.9902056Z",
      "LastEventUpdatedOnDate": "2020-04-03T07:18:54.9902056Z",
      "MaxActivityDate": "2020-04-03T07:18:54.9902056Z",
      "MinActivityDate": "2020-04-03T07:18:54.9902056Z"
    },
    "CreatedByContact": {
      "LinkToProfile": "sample string 1",
      "PictureUrl": "sample string 2",
      "ContactKey": "243e0cd6-efff-46b7-9c17-52c6bad102b9",
      "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": "2020-04-03T07:18:54.9902056Z",
      "UpdatedByContactKey": "0bc5c8d6-2ddd-4552-9f1a-72ad759332cf",
      "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": "2020-04-03T07:18:54.9902056Z"
    },
    "IntegrationKey": "sample string 30",
    "IntegrationTypeKey": "sample string 31",
    "ParentCommunityKey": "89bde856-1dc0-40e1-9f9d-7b310aade65f"
  }
]

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>4aa079d5-7e90-489c-8b00-ef7fde4b7047</CommunityKey>
    <CommunityName>sample string 6</CommunityName>
    <CommunitySize>7</CommunitySize>
    <CommunityType>sample string 8</CommunityType>
    <CommunityTypeKey>17abe3a7-5ebf-48df-9813-969bf7b456d8</CommunityTypeKey>
    <CommunityTypeName>sample string 10</CommunityTypeName>
    <CreatedByContact>
      <AMSDirectoryOptOut>true</AMSDirectoryOptOut>
      <AgreedToTermsDateTime>2020-04-03T03:18:54.9902056-04:00</AgreedToTermsDateTime>
      <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey>
      <CompanyName>sample string 12</CompanyName>
      <CompanyTitle>sample string 13</CompanyTitle>
      <ContactKey>243e0cd6-efff-46b7-9c17-52c6bad102b9</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>0bc5c8d6-2ddd-4552-9f1a-72ad759332cf</UpdatedByContactKey>
      <UpdatedOn>2020-04-03T03:18:54.9902056-04:00</UpdatedOn>
    </CreatedByContact>
    <CreatedByContactKey>96e44cb5-bee9-4231-a751-937fcb4eb94c</CreatedByContactKey>
    <CreatedOn>2020-04-03T03:18:54.9902056-04:00</CreatedOn>
    <Description>sample string 13</Description>
    <DiscussionKey>4ac103c1-ce0e-47c0-9551-c63e7cc7246f</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>cee2b5e7-6b7f-4f37-b0b8-0daa0fb39c54</JoinPermissionKey>
    <LegacyGroupKey>sample string 5</LegacyGroupKey>
    <LibraryKey>b20219c2-b6ba-4d11-abab-669df4fff039</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>8c861b45-d9aa-4285-9512-38f35afb1106</MicrositeGroupKey>
    <SiteName>sample string 28</SiteName>
    <Statistics>
      <BlogCount>1</BlogCount>
      <CurrentYearAnnouncementCount>5</CurrentYearAnnouncementCount>
      <CurrentYearEventCount>6</CurrentYearEventCount>
      <DiscussionPostCount>4</DiscussionPostCount>
      <DocumentCount>2</DocumentCount>
      <LastAnnouncementUpdatedOnDate>2020-04-03T03:18:54.9902056-04:00</LastAnnouncementUpdatedOnDate>
      <LastBlogPublishedDate>2020-04-03T03:18:54.9902056-04:00</LastBlogPublishedDate>
      <LastDocumentUpdatedDate>2020-04-03T03:18:54.9902056-04:00</LastDocumentUpdatedDate>
      <LastEventUpdatedOnDate>2020-04-03T03:18:54.9902056-04:00</LastEventUpdatedOnDate>
      <LastMemberJoinedDate>2020-04-03T03:18:54.9902056-04:00</LastMemberJoinedDate>
      <LastPostingDate>2020-04-03T03:18:54.9902056-04:00</LastPostingDate>
      <MaxActivityDate>2020-04-03T03:18:54.9902056-04:00</MaxActivityDate>
      <MemberCount>3</MemberCount>
      <MinActivityDate>2020-04-03T03:18:54.9902056-04:00</MinActivityDate>
    </Statistics>
    <ViewPermissionKey>64e6a438-9cc0-47b0-9976-8dd45f27d86e</ViewPermissionKey>
  </Community>
  <Community>
    <AllowMemberCreatedEvents>true</AllowMemberCreatedEvents>
    <AllowTickets>true</AllowTickets>
    <CanMembersInviteOthers>true</CanMembersInviteOthers>
    <CommunityKey>4aa079d5-7e90-489c-8b00-ef7fde4b7047</CommunityKey>
    <CommunityName>sample string 6</CommunityName>
    <CommunitySize>7</CommunitySize>
    <CommunityType>sample string 8</CommunityType>
    <CommunityTypeKey>17abe3a7-5ebf-48df-9813-969bf7b456d8</CommunityTypeKey>
    <CommunityTypeName>sample string 10</CommunityTypeName>
    <CreatedByContact>
      <AMSDirectoryOptOut>true</AMSDirectoryOptOut>
      <AgreedToTermsDateTime>2020-04-03T03:18:54.9902056-04:00</AgreedToTermsDateTime>
      <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey>
      <CompanyName>sample string 12</CompanyName>
      <CompanyTitle>sample string 13</CompanyTitle>
      <ContactKey>243e0cd6-efff-46b7-9c17-52c6bad102b9</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>0bc5c8d6-2ddd-4552-9f1a-72ad759332cf</UpdatedByContactKey>
      <UpdatedOn>2020-04-03T03:18:54.9902056-04:00</UpdatedOn>
    </CreatedByContact>
    <CreatedByContactKey>96e44cb5-bee9-4231-a751-937fcb4eb94c</CreatedByContactKey>
    <CreatedOn>2020-04-03T03:18:54.9902056-04:00</CreatedOn>
    <Description>sample string 13</Description>
    <DiscussionKey>4ac103c1-ce0e-47c0-9551-c63e7cc7246f</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>cee2b5e7-6b7f-4f37-b0b8-0daa0fb39c54</JoinPermissionKey>
    <LegacyGroupKey>sample string 5</LegacyGroupKey>
    <LibraryKey>b20219c2-b6ba-4d11-abab-669df4fff039</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>8c861b45-d9aa-4285-9512-38f35afb1106</MicrositeGroupKey>
    <SiteName>sample string 28</SiteName>
    <Statistics>
      <BlogCount>1</BlogCount>
      <CurrentYearAnnouncementCount>5</CurrentYearAnnouncementCount>
      <CurrentYearEventCount>6</CurrentYearEventCount>
      <DiscussionPostCount>4</DiscussionPostCount>
      <DocumentCount>2</DocumentCount>
      <LastAnnouncementUpdatedOnDate>2020-04-03T03:18:54.9902056-04:00</LastAnnouncementUpdatedOnDate>
      <LastBlogPublishedDate>2020-04-03T03:18:54.9902056-04:00</LastBlogPublishedDate>
      <LastDocumentUpdatedDate>2020-04-03T03:18:54.9902056-04:00</LastDocumentUpdatedDate>
      <LastEventUpdatedOnDate>2020-04-03T03:18:54.9902056-04:00</LastEventUpdatedOnDate>
      <LastMemberJoinedDate>2020-04-03T03:18:54.9902056-04:00</LastMemberJoinedDate>
      <LastPostingDate>2020-04-03T03:18:54.9902056-04:00</LastPostingDate>
      <MaxActivityDate>2020-04-03T03:18:54.9902056-04:00</MaxActivityDate>
      <MemberCount>3</MemberCount>
      <MinActivityDate>2020-04-03T03:18:54.9902056-04:00</MinActivityDate>
    </Statistics>
    <ViewPermissionKey>64e6a438-9cc0-47b0-9976-8dd45f27d86e</ViewPermissionKey>
  </Community>
</ArrayOfCommunity>