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.

GetCommunityMembersRequest
NameDescriptionTypeAdditional 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

Sample: 
{
  "CommunityKey": "3a2f512d-191e-4b72-8cf4-2febf676c82a",
  "LegacyGroupKey": "sample string 2",
  "StartRecord": 1,
  "EndRecord": 1
}

application/xml, text/xml

Sample: 
<GetCommunityMembersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request">
  <CommunityKey>3a2f512d-191e-4b72-8cf4-2febf676c82a</CommunityKey>
  <EndRecord>1</EndRecord>
  <LegacyGroupKey>sample string 2</LegacyGroupKey>
  <StartRecord>1</StartRecord>
</GetCommunityMembersRequest>

Response Information

Resource Description

List of Contact records.

Collection of CommunityMember
NameDescriptionTypeAdditional 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

Sample: 
[
  {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "51f0a716-fd48-4195-9770-5428fb7915e6",
    "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-12-26T00:43:51.9682291Z",
    "UpdatedByContactKey": "9084f6eb-ff7f-442e-85d9-26900eef0dcf",
    "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-12-26T00:43:51.9682291Z",
    "AcceptedOn": "2024-12-26T00:43:51.9682291Z",
    "Community": null,
    "CommunityMemberRoles": "sample string 25",
    "InvitedByContactKey": "ef86e790-1958-4c33-9147-7f7217086241",
    "InvitedOn": "2024-12-26T00:43:51.9682291Z",
    "IsActive": true,
    "IsAdmin": true,
    "RemovedOn": "2024-12-26T00:43:51.9682291Z",
    "StartDate": "2024-12-26T00:43:51.9682291Z",
    "EndDate": "2024-12-26T00:43:51.9682291Z"
  },
  {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "51f0a716-fd48-4195-9770-5428fb7915e6",
    "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-12-26T00:43:51.9682291Z",
    "UpdatedByContactKey": "9084f6eb-ff7f-442e-85d9-26900eef0dcf",
    "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-12-26T00:43:51.9682291Z",
    "AcceptedOn": "2024-12-26T00:43:51.9682291Z",
    "Community": null,
    "CommunityMemberRoles": "sample string 25",
    "InvitedByContactKey": "ef86e790-1958-4c33-9147-7f7217086241",
    "InvitedOn": "2024-12-26T00:43:51.9682291Z",
    "IsActive": true,
    "IsAdmin": true,
    "RemovedOn": "2024-12-26T00:43:51.9682291Z",
    "StartDate": "2024-12-26T00:43:51.9682291Z",
    "EndDate": "2024-12-26T00:43:51.9682291Z"
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.