List Group REST Endpoint

Ben Tiedt — Tue, 19 Nov 2019 20:22:42 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:22:42

URLs

GET api.ashx/v2/groups.xml (or .json)

LIST groups.

GET api.ashx/v2/groups/{parentgroupid}/groups.xml (or .json)

LIST sub-groups for a group.

GET api.ashx/v2/users/{userid}/groups.xml (or .json)

LIST groups for which the user is any type of member by user id.

GET api.ashx/v2/users/{username}/groups.xml (or .json)

LIST groups for which the user is any type of member by username.

Request Parameters

Name	Type	Description	Required
UserId	`int?`	User Id	Optional
Username	`string`	Username	Optional
IncludePendingMemberships	`bool?`	When getting groups for a user, include groups where user has PendingMembership	Optional
ParentGroupId	`int?`	Setting a Parent Group Id returns just the child groups for the group.	Optional
IncludeAllSubGroups	`bool?`	Used when getting child groups, will return all subgroups recursively.	Optional
GroupTypes	`string`	Values include: Joinless, PublicOpen, PublicClosed, PrivateUnlisted, PrivateListed, or All.	Optional
GroupNameFilter	`string`	Used to filter results by matching group name.	Optional
ContainerIds	`string`	Comma separated list of ContainerIds. Used to limit to a specific set of groups as well as sort order if SoryBy is set to ContainerIdsOrder	Optional
Permission	`string`	Used to only get groups where the specified permission is valid.	Optional
SortBy	`string`	Options include Name, SortOrder, LastUpdate, ContainerIdsOrder. Default is Name.	Optional
SortOrder	`string`	Options include Ascending, Descending. Default is Ascending.	Optional
PageSize	`int?`	Specify the number of results to return per page. If not set the default is 20. The max is 100.	Optional
PageIndex	`int?`	Specify the page number of paged results to return. Zero-based index. If not specified the default is 0.	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.json", false);

Widget Javascript

This example uses the [[rest JavaScript API Module|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.json',
	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.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>
  <Groups PageSize="2" PageIndex="0" TotalCount="2">
    <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>
    <Group>
      <Id>52</Id>
      <AvatarUrl>avatarurl</AvatarUrl>
      <DateCreated>2012-05-02T00:00:00</DateCreated>
      <Description>description</Description>
      <Key>key</Key>
      <Name>name</Name>
      <ParentGroupId>7</ParentGroupId>
      <Url>url</Url>
      <TotalMembers>27</TotalMembers>
      <HasGroups>true</HasGroups>
      <GroupCount>32</GroupCount>
      <GroupType>grouptype</GroupType>
      <EnableGroupMessages>true</EnableGroupMessages>
      <EnableContact>true</EnableContact>
      <SearchUniqueId>searchuniqueid</SearchUniqueId>
      <ExtendedAttributes>
        <key>value</key>
        <key>value</key>
      </ExtendedAttributes>
      <ContainerId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerId>
      <Container>
        <ContainerId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerId>
        <ContainerTypeId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerTypeId>
        <HtmlName>htmlname</HtmlName>
        <Url>url</Url>
        <AvatarUrl>avatarurl</AvatarUrl>
      </Container>
    </Group>
  </Groups>
</Response>

JSON

{
  "PageSize": 2,
  "PageIndex": 0,
  "TotalCount": 2,
  "Groups": [
    {
      "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",
      "DateCreated": "2012-05-02T00:00:00",
      "Description": "description",
      "Key": "key",
      "Name": "name",
      "ParentGroupId": 7,
      "Url": "url",
      "TotalMembers": 27,
      "HasGroups": true,
      "GroupCount": 32,
      "GroupType": "grouptype",
      "EnableGroupMessages": true,
      "EnableContact": true,
      "SearchUniqueId": "searchuniqueid",
      "IsEnabled": true,
      "ExtendedAttributes": [
        {
          "Key": "key",
          "Value": "value"
        },
        {
          "Key": "key",
          "Value": "value"
        }
      ],
      "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
      "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
      "Container": {
        "ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
        "ContainerTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
        "HtmlName": "htmlname",
        "Url": "url",
        "AvatarUrl": "avatarurl"
      },
      "Id": 52
    }
  ],
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}