POST api/v2.0/Communities/GetCommunityMembers
Retrieve a list of Members of the specified Community in LastName, FirstName order.
Request Information
URI Parameters
None.
Body Parameters
CommunityKey: CommunityKey for the Community to retrieve. Either CommunityKey or LegacyGroupKey must be supplied. If both CommunityKey and LegacyGroupKey are supplied, CommunityKey will take precedence.
GetCommunityMembersRequestName | Description | Type | Additional information |
---|---|---|---|
CommunityKey |
Unique Identifier for a Community in Higher Logic |
globally unique identifier |
None. |
LegacyGroupKey |
Unique Identifier for a Community in the source system |
string |
None. |
StartRecord |
Index of the first record to retrieve. Defaults to 1 if not supplied. |
integer |
None. |
EndRecord |
Index of the last record to retrieve. Defaults to 50 if not supplied. |
integer |
None. |
Request Formats
application/json, text/json
{ "CommunityKey": "dcc6ee7a-00fd-4f3a-ad79-aa18c191502b", "LegacyGroupKey": "sample string 2", "StartRecord": 1, "EndRecord": 1 }
application/xml, text/xml
<GetCommunityMembersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request"> <CommunityKey>dcc6ee7a-00fd-4f3a-ad79-aa18c191502b</CommunityKey> <EndRecord>1</EndRecord> <LegacyGroupKey>sample string 2</LegacyGroupKey> <StartRecord>1</StartRecord> </GetCommunityMembersRequest>
Response Information
Resource Description
List of Contact records.
Collection of CommunityMemberName | Description | Type | Additional information |
---|---|---|---|
LinkToProfile |
Url link to this Contact's Profile page in the Community site. |
string |
None. |
PictureUrl |
Url link to this Contact's small Profile Picture. |
string |
None. |
ContactKey |
Unique Identifier for this Contact. |
globally unique identifier |
None. |
FirstName |
Contact's first name. |
string |
None. |
LastName |
Contact's last name. |
string |
None. |
DisplayName |
Calculated Display name. |
string |
None. |
EmailAddress |
Contact's email address. |
string |
None. |
ContactStatusCode |
Status code for this contact. |
string |
None. |
PrefixCode |
Prefix code for this contact. |
string |
None. |
UpdatedOn |
Last Updated date for this contact. |
date |
None. |
UpdatedByContactKey |
Last Contact that made an update to this contact's record. |
globally unique identifier |
None. |
CompanyName |
Name of this contact's company. |
string |
None. |
CompanyTitle |
Title for this contact at their company. |
string |
None. |
SuffixCode |
Contact's suffix. |
string |
None. |
Designation |
Designation. |
string |
None. |
LegacyContactKey |
Unique Identifier for this contact in the source system. |
string |
None. |
InformalName |
Informal Name. |
string |
None. |
MiddleName |
Contact's Middle Name. |
string |
None. |
IsCompany |
Is this contact a company. |
boolean |
None. |
CompanyLegacyContactKey |
Unique Identifier for the Company (if applicable) in the source system. |
string |
None. |
AMSDirectoryOptOut |
Does this Contact opt-out of being part of the Source System directory? |
boolean |
None. |
HLDirectoryOptOut |
Does this Contact opt-out of being part of the Higher Logic directory? |
boolean |
None. |
HLContactMeOptOut |
Does this Contact opt-out of being contacted? |
boolean |
None. |
LargePictureUrl |
Url link to this Contact's large Profile Picture. |
string |
None. |
AgreedToTermsDateTime |
Date that this Contact agreed to the site terms (if applicable). |
date |
None. |
AcceptedOn |
Date this Contact was added to the Community. |
date |
None. |
Community |
Detail about the Community. |
Community |
None. |
CommunityMemberRoles |
List of Roles that this Contact holds within the Community. |
string |
None. |
InvitedByContactKey |
If applicable, the Contact Key of the user that invited this Contact to the Community. |
globally unique identifier |
None. |
InvitedOn |
If applicable, the date this Contact was invited to join this Community. |
date |
None. |
IsActive |
Is this Contact's membership to the Community active? |
boolean |
None. |
IsAdmin |
Is this Contact a Community Admin? |
boolean |
None. |
RemovedOn |
If applicable, the date this Contact was removed from this Community. |
date |
None. |
StartDate |
If applicable, the date this Contact's Community Membership began/begins for the Community. |
date |
None. |
EndDate |
If applicable, the date this Contact's Community Membership ended/ends for the Community. |
date |
None. |
Response Formats
application/json, text/json
[ { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "f6c74636-2bcf-44ea-b6c8-ef858305e6d9", "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": "2024-11-02T17:05:22.121251Z", "UpdatedByContactKey": "32bef2d2-2ac9-4b0c-b55d-5b7887e6172b", "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": "2024-11-02T17:05:22.121251Z", "AcceptedOn": "2024-11-02T17:05:22.121251Z", "Community": null, "CommunityMemberRoles": "sample string 25", "InvitedByContactKey": "e6f8362c-e86a-4a9d-8d1d-3b68ce31892e", "InvitedOn": "2024-11-02T17:05:22.121251Z", "IsActive": true, "IsAdmin": true, "RemovedOn": "2024-11-02T17:05:22.121251Z", "StartDate": "2024-11-02T17:05:22.121251Z", "EndDate": "2024-11-02T17:05:22.121251Z" }, { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "f6c74636-2bcf-44ea-b6c8-ef858305e6d9", "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": "2024-11-02T17:05:22.121251Z", "UpdatedByContactKey": "32bef2d2-2ac9-4b0c-b55d-5b7887e6172b", "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": "2024-11-02T17:05:22.121251Z", "AcceptedOn": "2024-11-02T17:05:22.121251Z", "Community": null, "CommunityMemberRoles": "sample string 25", "InvitedByContactKey": "e6f8362c-e86a-4a9d-8d1d-3b68ce31892e", "InvitedOn": "2024-11-02T17:05:22.121251Z", "IsActive": true, "IsAdmin": true, "RemovedOn": "2024-11-02T17:05:22.121251Z", "StartDate": "2024-11-02T17:05:22.121251Z", "EndDate": "2024-11-02T17:05:22.121251Z" } ]
application/xml
Sample not available.
text/xml
Sample not available.