URLs
GET api.ashx/v2/groups/{groupid}/members/{userid}.xml (or .json)
SHOW a members details for a group. This endpoint is deprecated use: /groups/{groupid}/members/users/{userid}.{format} instead.
GET api.ashx/v2/groups/{groupid}/members/{username}.xml (or .json)
SHOW a members details for a group. This endpoint is deprecated use: /groups/{groupid}/members/users/{username}.{format} instead.
GET api.ashx/v2/groups/{groupid}/members/roles/{roleid}.xml (or .json)
SHOW member details for a role in a group.
GET api.ashx/v2/groups/{groupid}/members/roles/{rolename}.xml (or .json)
SHOW member details for a role in a group.
GET api.ashx/v2/groups/{groupid}/members/users/{userid}.xml (or .json)
SHOW member details for a user in a group.
GET api.ashx/v2/groups/{groupid}/members/users/{username}.xml (or .json)
SHOW member details for a user in a group.
Request Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
GroupId | int | Group Id | Required | ||
UserId | int? | Either UserId or Username is required when getting details for a user member. | Optional | ||
Username | string | Either UserId or Username is required when getting details for a user member. | Optional | ||
RoleId | int? | Either RoleId or Rolename is required when getting details for a role member. | Optional | ||
Rolename | string | Either RoleId or Rolename is required when getting details for a role member. | Optional |
Example Requests
C# REST SDK
This example uses the REST SDK to access the Community REST API within a .Net C# application. In the example, USER_NAME
is the user name of the effective user for the request and OAUTH_CLIENT_ID
and OAUTH_SECRET
are the OAuth client ID and secret, respectively, associated to this application as configured in Administration > Integration > OAuth Clients with the "Client Credentials" grant type enabled. See the documentation for the REST SDK for more details about installation, configuration, and usage options.
var host = new ClientCredentialsRestHost("USER_NAME", "https://mysite.com/", "OAUTH_CLIENT_ID", "OAUTH_SECRET"); var response = host.GetToDynamic(2, "groups/{groupid}/members/{userid}.json", false, new RestGetOptions { PathParameters = new System.Collections.Specialized.NameValueCollection { { "groupid", "6" }, { "userid", "6" } } });
Widget Javascript
This example uses the rest JavaScript API to access the Community REST API within the Community web UI. When accessing the REST API through the javascript API, the effective user is the current contextual user of the web interface.
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/groups/{groupid}/members/{userid}.json', data: { 'groupid': '6', 'userid': '6' }, success: function(response) { } });
cURL
This example uses the cURL command-line HTTP utility. ENCODED_TOKEN
in the example is the base64-encoded concatenation of the user's API key (created from the user's profile), a colon (:), and the user's user name. Learn more about using the REST API.
curl -H "Rest-User-Token: ENCODED_TOKEN" -X GET https://mysite.com/api.ashx/v2/groups/6/members/6.xml
Example Responses
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <User> <Id>32</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <Author> <Id>18</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <Author> <Id>27</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>2d525bad-c4df-470d-a193-a1c6d66e5c3e</Id> <Body>body</Body> <CreatedDate /> <ReplyCount>7</ReplyCount> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> </CurrentStatus> </Author> <Body>body</Body> <CreatedDate>2012-05-02T00:00:00</CreatedDate> <ReplyCount>32</ReplyCount> <Group> <Id>61</Id> <AvatarUrl>avatarurl</AvatarUrl> <DateCreated>2012-06-04T00:00:00</DateCreated> <Description>description</Description> <Key>key</Key> <Name>name</Name> <ParentGroupId>52</ParentGroupId> <Url>url</Url> <TotalMembers>19</TotalMembers> <HasGroups>true</HasGroups> <GroupCount>112</GroupCount> <GroupType>grouptype</GroupType> <EnableGroupMessages>true</EnableGroupMessages> <EnableContact>true</EnableContact> <SearchUniqueId>searchuniqueid</SearchUniqueId> <ExtendedAttributes /> <ContainerId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerId> <Container> <ContainerId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerId> <ContainerTypeId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerTypeId> <HtmlName>htmlname</HtmlName> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Container> </Group> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> <Content> <CreatedByUser> <Id /> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> </CreatedByUser> <ContentId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentId> <ContentTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentTypeId> <CreatedDate>2011-05-28T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Application> <ApplicationId>fe65240b-044c-4292-9946-f10e0361ecff</ApplicationId> <ApplicationTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ApplicationTypeId> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Application> </Content> </CurrentStatus> </Author> <Body>body</Body> <CreatedDate>2011-12-09T00:00:00</CreatedDate> <ReplyCount>76</ReplyCount> <Group> <Id>4</Id> <AvatarUrl>avatarurl</AvatarUrl> <DateCreated>2012-03-29T00:00:00</DateCreated> <Description>description</Description> <Key>key</Key> <Name>name</Name> <ParentGroupId>6</ParentGroupId> <Url>url</Url> <TotalMembers>25</TotalMembers> <HasGroups>true</HasGroups> <GroupCount>8</GroupCount> <GroupType>grouptype</GroupType> <EnableGroupMessages>true</EnableGroupMessages> <EnableContact>true</EnableContact> <SearchUniqueId>searchuniqueid</SearchUniqueId> <ExtendedAttributes> <key>value</key> <key>value</key> </ExtendedAttributes> <ContainerId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerId> <Container> <ContainerId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerId> <ContainerTypeId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerTypeId> <HtmlName>htmlname</HtmlName> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Container> </Group> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>fe65240b-044c-4292-9946-f10e0361ecff</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> <Content> <CreatedByUser> <Id>27</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <Author> <Id /> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> </Author> <Body>body</Body> <CreatedDate>2012-04-19T00:00:00</CreatedDate> <ReplyCount>7</ReplyCount> <Group> <Id /> <AvatarUrl>avatarurl</AvatarUrl> <DateCreated /> <Description>description</Description> <Key>key</Key> <Name>name</Name> <Url>url</Url> <TotalMembers /> <HasGroups>true</HasGroups> <GroupCount /> <GroupType>grouptype</GroupType> <EnableGroupMessages>true</EnableGroupMessages> <EnableContact>true</EnableContact> <SearchUniqueId>searchuniqueid</SearchUniqueId> <ExtendedAttributes /> <ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId> </Group> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> <Content> <ContentId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentId> <ContentTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContentTypeId> <CreatedDate>2012-01-16T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Content> </CurrentStatus> </CreatedByUser> <ContentId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContentId> <ContentTypeId>6cdcf200-3bad-476d-af45-97b52545c337</ContentTypeId> <CreatedDate>2012-01-04T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Application> <ApplicationId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ApplicationId> <ApplicationTypeId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ApplicationTypeId> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Container> <ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId> <ContainerTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerTypeId> <HtmlName>htmlname</HtmlName> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Container> </Application> </Content> </CurrentStatus> <MembershipType>membershiptype</MembershipType> <IsDirectMember>true</IsDirectMember> <IsRoleMember>true</IsRoleMember> <Group> <Id>4</Id> <AvatarUrl>avatarurl</AvatarUrl> <DateCreated>2012-01-04T00:00:00</DateCreated> <Description>description</Description> <Key>key</Key> <Name>name</Name> <ParentGroupId>6</ParentGroupId> <Url>url</Url> <TotalMembers>25</TotalMembers> <HasGroups>true</HasGroups> <GroupCount>8</GroupCount> <GroupType>grouptype</GroupType> <EnableGroupMessages>true</EnableGroupMessages> <EnableContact>true</EnableContact> <SearchUniqueId>searchuniqueid</SearchUniqueId> <ExtendedAttributes> <key>value</key> <key>value</key> </ExtendedAttributes> <ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId> <Container> <ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId> <ContainerTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerTypeId> <HtmlName>htmlname</HtmlName> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Container> </Group> </User> <Role> <Id>6</Id> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <PermissionEntries> <PermissionEntry> <Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> <MembershipType>membershiptype</MembershipType> </Role> </Response>
JSON
{ "User": { "MembershipType": "membershiptype", "IsDirectMember": true, "IsRoleMember": true, "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-01-04T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 6, "Url": "url", "TotalMembers": 25, "HasGroups": true, "GroupCount": 8, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [ { "Key": "key", "Value": "value" }, { "Key": "key", "Value": "value" } ], "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": { "ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ContainerTypeId": "fe65240b-044c-4292-9946-f10e0361ecff", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" }, "Id": 4 }, "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": null, "Body": "body", "CreatedDate": null, "ReplyCount": 7, "Group": null, "AttachedUrl": "attachedurl", "HasReplies": null, "ContentId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": null, "Id": "2d525bad-c4df-470d-a193-a1c6d66e5c3e" }, "Id": 27 }, "Body": "body", "CreatedDate": "2012-05-02T00:00:00", "ReplyCount": 32, "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-06-04T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 52, "Url": "url", "TotalMembers": 19, "HasGroups": true, "GroupCount": 112, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": { "ContainerId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "ContainerTypeId": "6cdcf200-3bad-476d-af45-97b52545c337", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" }, "Id": 61 }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "ContentId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContentTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "CreatedDate": "2011-05-28T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": { "ApplicationId": "fe65240b-044c-4292-9946-f10e0361ecff", "ApplicationTypeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Container": null } }, "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1" }, "Id": 18 }, "Body": "body", "CreatedDate": "2011-12-09T00:00:00", "ReplyCount": 76, "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-03-29T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 6, "Url": "url", "TotalMembers": 25, "HasGroups": true, "GroupCount": 8, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [ { "Key": "key", "Value": "value" }, { "Key": "key", "Value": "value" } ], "ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": { "ContainerId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "ContainerTypeId": "6cdcf200-3bad-476d-af45-97b52545c337", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" }, "Id": 4 }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "fe65240b-044c-4292-9946-f10e0361ecff", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2012-04-19T00:00:00", "ReplyCount": 7, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "ContentTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "CreatedDate": "2012-01-16T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f" }, "Id": 27 }, "ContentId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "ContentTypeId": "6cdcf200-3bad-476d-af45-97b52545c337", "CreatedDate": "2012-01-04T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": { "ApplicationId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "ApplicationTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Container": { "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContainerTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" } } }, "Id": "fe65240b-044c-4292-9946-f10e0361ecff" }, "Id": 32 }, "Role": { "MembershipType": "membershiptype", "Id": 6, "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "PermissionEntries": [ { "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }