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

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "21b630c0-393b-4999-9306-482acd899890",
    "LegacyGroupKey": "sample string 5",
    "CommunityName": "sample string 6",
    "CommunitySize": 7,
    "CommunityType": "sample string 8",
    "CommunityTypeKey": "185a5158-fbea-452f-afd3-88729b09624d",
    "CommunityTypeName": "sample string 10",
    "CreatedByContactKey": "c7c4fd7d-3727-4b7d-a28f-87f2fa0ca37c",
    "CreatedOn": "2020-02-23T01:11:52.5231798Z",
    "Description": "sample string 13",
    "Html": "sample string 14",
    "IsSubscribedToDiscussion": true,
    "IsOnCommunitySync": true,
    "JoinPermissionKey": "a4f60b87-78c4-490c-b961-5727ab088196",
    "LibraryKey": "e35bfee3-46f3-434e-88db-83f51b9b887e",
    "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": "fe6c59e8-26e0-4b79-972c-d1a06f10321b",
    "DiscussionName": "sample string 26",
    "MicrositeGroupKey": "437d966e-5dbd-4d26-b6e2-6c23d0400bf3",
    "SiteName": "sample string 28",
    "ViewPermissionKey": "bd5d6868-eee7-4d72-a5b5-644dda41c161",
    "Statistics": {
      "BlogCount": 1,
      "DocumentCount": 2,
      "MemberCount": 3,
      "DiscussionPostCount": 4,
      "CurrentYearAnnouncementCount": 5,
      "CurrentYearEventCount": 6,
      "LastDocumentUpdatedDate": "2020-02-23T01:11:52.5231798Z",
      "LastMemberJoinedDate": "2020-02-23T01:11:52.5231798Z",
      "LastPostingDate": "2020-02-23T01:11:52.5231798Z",
      "LastBlogPublishedDate": "2020-02-23T01:11:52.5231798Z",
      "LastAnnouncementUpdatedOnDate": "2020-02-23T01:11:52.5231798Z",
      "LastEventUpdatedOnDate": "2020-02-23T01:11:52.5231798Z",
      "MaxActivityDate": "2020-02-23T01:11:52.5231798Z",
      "MinActivityDate": "2020-02-23T01:11:52.5231798Z"
    },
    "CreatedByContact": {
      "LinkToProfile": "sample string 1",
      "PictureUrl": "sample string 2",
      "ContactKey": "bee2b6d1-3aef-45ee-96f9-dd65b3b01ae9",
      "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-02-23T01:11:52.5231798Z",
      "UpdatedByContactKey": "4d0fa568-ed50-4ae5-a5e6-b74a07e14b56",
      "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-02-23T01:11:52.5231798Z"
    },
    "IntegrationKey": "sample string 30",
    "IntegrationTypeKey": "sample string 31",
    "ParentCommunityKey": "6064270a-9eaf-4aa9-b0cc-99cd5dca9d93"
  },
  {
    "AllowMemberCreatedEvents": true,
    "AllowTickets": true,
    "CanMembersInviteOthers": true,
    "CommunityKey": "21b630c0-393b-4999-9306-482acd899890",
    "LegacyGroupKey": "sample string 5",
    "CommunityName": "sample string 6",
    "CommunitySize": 7,
    "CommunityType": "sample string 8",
    "CommunityTypeKey": "185a5158-fbea-452f-afd3-88729b09624d",
    "CommunityTypeName": "sample string 10",
    "CreatedByContactKey": "c7c4fd7d-3727-4b7d-a28f-87f2fa0ca37c",
    "CreatedOn": "2020-02-23T01:11:52.5231798Z",
    "Description": "sample string 13",
    "Html": "sample string 14",
    "IsSubscribedToDiscussion": true,
    "IsOnCommunitySync": true,
    "JoinPermissionKey": "a4f60b87-78c4-490c-b961-5727ab088196",
    "LibraryKey": "e35bfee3-46f3-434e-88db-83f51b9b887e",
    "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": "fe6c59e8-26e0-4b79-972c-d1a06f10321b",
    "DiscussionName": "sample string 26",
    "MicrositeGroupKey": "437d966e-5dbd-4d26-b6e2-6c23d0400bf3",
    "SiteName": "sample string 28",
    "ViewPermissionKey": "bd5d6868-eee7-4d72-a5b5-644dda41c161",
    "Statistics": {
      "BlogCount": 1,
      "DocumentCount": 2,
      "MemberCount": 3,
      "DiscussionPostCount": 4,
      "CurrentYearAnnouncementCount": 5,
      "CurrentYearEventCount": 6,
      "LastDocumentUpdatedDate": "2020-02-23T01:11:52.5231798Z",
      "LastMemberJoinedDate": "2020-02-23T01:11:52.5231798Z",
      "LastPostingDate": "2020-02-23T01:11:52.5231798Z",
      "LastBlogPublishedDate": "2020-02-23T01:11:52.5231798Z",
      "LastAnnouncementUpdatedOnDate": "2020-02-23T01:11:52.5231798Z",
      "LastEventUpdatedOnDate": "2020-02-23T01:11:52.5231798Z",
      "MaxActivityDate": "2020-02-23T01:11:52.5231798Z",
      "MinActivityDate": "2020-02-23T01:11:52.5231798Z"
    },
    "CreatedByContact": {
      "LinkToProfile": "sample string 1",
      "PictureUrl": "sample string 2",
      "ContactKey": "bee2b6d1-3aef-45ee-96f9-dd65b3b01ae9",
      "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-02-23T01:11:52.5231798Z",
      "UpdatedByContactKey": "4d0fa568-ed50-4ae5-a5e6-b74a07e14b56",
      "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-02-23T01:11:52.5231798Z"
    },
    "IntegrationKey": "sample string 30",
    "IntegrationTypeKey": "sample string 31",
    "ParentCommunityKey": "6064270a-9eaf-4aa9-b0cc-99cd5dca9d93"
  }
]

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>21b630c0-393b-4999-9306-482acd899890</CommunityKey>
    <CommunityName>sample string 6</CommunityName>
    <CommunitySize>7</CommunitySize>
    <CommunityType>sample string 8</CommunityType>
    <CommunityTypeKey>185a5158-fbea-452f-afd3-88729b09624d</CommunityTypeKey>
    <CommunityTypeName>sample string 10</CommunityTypeName>
    <CreatedByContact>
      <AMSDirectoryOptOut>true</AMSDirectoryOptOut>
      <AgreedToTermsDateTime>2020-02-22T20:11:52.5231798-05:00</AgreedToTermsDateTime>
      <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey>
      <CompanyName>sample string 12</CompanyName>
      <CompanyTitle>sample string 13</CompanyTitle>
      <ContactKey>bee2b6d1-3aef-45ee-96f9-dd65b3b01ae9</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>4d0fa568-ed50-4ae5-a5e6-b74a07e14b56</UpdatedByContactKey>
      <UpdatedOn>2020-02-22T20:11:52.5231798-05:00</UpdatedOn>
    </CreatedByContact>
    <CreatedByContactKey>c7c4fd7d-3727-4b7d-a28f-87f2fa0ca37c</CreatedByContactKey>
    <CreatedOn>2020-02-22T20:11:52.5231798-05:00</CreatedOn>
    <Description>sample string 13</Description>
    <DiscussionKey>fe6c59e8-26e0-4b79-972c-d1a06f10321b</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>a4f60b87-78c4-490c-b961-5727ab088196</JoinPermissionKey>
    <LegacyGroupKey>sample string 5</LegacyGroupKey>
    <LibraryKey>e35bfee3-46f3-434e-88db-83f51b9b887e</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>437d966e-5dbd-4d26-b6e2-6c23d0400bf3</MicrositeGroupKey>
    <SiteName>sample string 28</SiteName>
    <Statistics>
      <BlogCount>1</BlogCount>
      <CurrentYearAnnouncementCount>5</CurrentYearAnnouncementCount>
      <CurrentYearEventCount>6</CurrentYearEventCount>
      <DiscussionPostCount>4</DiscussionPostCount>
      <DocumentCount>2</DocumentCount>
      <LastAnnouncementUpdatedOnDate>2020-02-22T20:11:52.5231798-05:00</LastAnnouncementUpdatedOnDate>
      <LastBlogPublishedDate>2020-02-22T20:11:52.5231798-05:00</LastBlogPublishedDate>
      <LastDocumentUpdatedDate>2020-02-22T20:11:52.5231798-05:00</LastDocumentUpdatedDate>
      <LastEventUpdatedOnDate>2020-02-22T20:11:52.5231798-05:00</LastEventUpdatedOnDate>
      <LastMemberJoinedDate>2020-02-22T20:11:52.5231798-05:00</LastMemberJoinedDate>
      <LastPostingDate>2020-02-22T20:11:52.5231798-05:00</LastPostingDate>
      <MaxActivityDate>2020-02-22T20:11:52.5231798-05:00</MaxActivityDate>
      <MemberCount>3</MemberCount>
      <MinActivityDate>2020-02-22T20:11:52.5231798-05:00</MinActivityDate>
    </Statistics>
    <ViewPermissionKey>bd5d6868-eee7-4d72-a5b5-644dda41c161</ViewPermissionKey>
  </Community>
  <Community>
    <AllowMemberCreatedEvents>true</AllowMemberCreatedEvents>
    <AllowTickets>true</AllowTickets>
    <CanMembersInviteOthers>true</CanMembersInviteOthers>
    <CommunityKey>21b630c0-393b-4999-9306-482acd899890</CommunityKey>
    <CommunityName>sample string 6</CommunityName>
    <CommunitySize>7</CommunitySize>
    <CommunityType>sample string 8</CommunityType>
    <CommunityTypeKey>185a5158-fbea-452f-afd3-88729b09624d</CommunityTypeKey>
    <CommunityTypeName>sample string 10</CommunityTypeName>
    <CreatedByContact>
      <AMSDirectoryOptOut>true</AMSDirectoryOptOut>
      <AgreedToTermsDateTime>2020-02-22T20:11:52.5231798-05:00</AgreedToTermsDateTime>
      <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey>
      <CompanyName>sample string 12</CompanyName>
      <CompanyTitle>sample string 13</CompanyTitle>
      <ContactKey>bee2b6d1-3aef-45ee-96f9-dd65b3b01ae9</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>4d0fa568-ed50-4ae5-a5e6-b74a07e14b56</UpdatedByContactKey>
      <UpdatedOn>2020-02-22T20:11:52.5231798-05:00</UpdatedOn>
    </CreatedByContact>
    <CreatedByContactKey>c7c4fd7d-3727-4b7d-a28f-87f2fa0ca37c</CreatedByContactKey>
    <CreatedOn>2020-02-22T20:11:52.5231798-05:00</CreatedOn>
    <Description>sample string 13</Description>
    <DiscussionKey>fe6c59e8-26e0-4b79-972c-d1a06f10321b</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>a4f60b87-78c4-490c-b961-5727ab088196</JoinPermissionKey>
    <LegacyGroupKey>sample string 5</LegacyGroupKey>
    <LibraryKey>e35bfee3-46f3-434e-88db-83f51b9b887e</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>437d966e-5dbd-4d26-b6e2-6c23d0400bf3</MicrositeGroupKey>
    <SiteName>sample string 28</SiteName>
    <Statistics>
      <BlogCount>1</BlogCount>
      <CurrentYearAnnouncementCount>5</CurrentYearAnnouncementCount>
      <CurrentYearEventCount>6</CurrentYearEventCount>
      <DiscussionPostCount>4</DiscussionPostCount>
      <DocumentCount>2</DocumentCount>
      <LastAnnouncementUpdatedOnDate>2020-02-22T20:11:52.5231798-05:00</LastAnnouncementUpdatedOnDate>
      <LastBlogPublishedDate>2020-02-22T20:11:52.5231798-05:00</LastBlogPublishedDate>
      <LastDocumentUpdatedDate>2020-02-22T20:11:52.5231798-05:00</LastDocumentUpdatedDate>
      <LastEventUpdatedOnDate>2020-02-22T20:11:52.5231798-05:00</LastEventUpdatedOnDate>
      <LastMemberJoinedDate>2020-02-22T20:11:52.5231798-05:00</LastMemberJoinedDate>
      <LastPostingDate>2020-02-22T20:11:52.5231798-05:00</LastPostingDate>
      <MaxActivityDate>2020-02-22T20:11:52.5231798-05:00</MaxActivityDate>
      <MemberCount>3</MemberCount>
      <MinActivityDate>2020-02-22T20:11:52.5231798-05:00</MinActivityDate>
    </Statistics>
    <ViewPermissionKey>bd5d6868-eee7-4d72-a5b5-644dda41c161</ViewPermissionKey>
  </Community>
</ArrayOfCommunity>