---
title: "API: getGroup"
slug: "api-getgroup"
tags: ["home groups"]
updated: 2023-01-18T15:46:03Z
published: 2023-01-18T15:46:04Z
canonical: "support.smarteru.com/api-getgroup"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.smarteru.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API: getGroup

- Starting June 1, 2022, SmarterU will require all API calls to POST to HTTPS. Any POST to HTTP will result in the SU:01 error (i.e., No POST data detected.).
- If you are viewing the help in a language other than English, please change your language to English before copying and pasting any code. All API attributes and functions are in English.
- Tags are required unless specified.

## Description

The getGroup method retrieve's a group's details.

## Who Has Access

The following users have access to the getGroup method:

- Users with the [Group Manager](/v1/docs/group-permission-group-manager-gm), [Manage Group Courses](/v1/docs/group-permission-manage-group-courses-mgc), or [Manage Group Users](/v1/docs/group-permission-manage-group-users-mgu) group permission.
- [Administrators and owners](/v1/docs/user-profile-information#access-level).

## API Call XML Package

```markup
<SmarterU>
   <AccountAPI><![CDATA[]]></AccountAPI>
   <UserAPI><![CDATA[]]></UserAPI>
   <Method>getGroup</Method>
   <Parameters>
      <Group>
         <Name><![CDATA[]]></Name>
            - OR -
         <GroupID><![CDATA[]]></GroupID>
      </Group>
    </Parameters>
</SmarterU>
```

## Group Tag Group

The Group tag group is a container for the group filters.

```markup
<Group>
   <Name><![CDATA[]]></Name>
      - OR -
   <GroupID><![CDATA[]]></GroupID>
 </Group>
```

The Group tag contains one of the following.

### Name

The [group's name](/v1/docs/group-group-information#name). This tag is mutually exclusive with the [GroupID tag](/v1/docs/api-getgroup#groupid). This is the Name returned by the [listGroups](/v1/docs/api-listgroups) method.

### GroupID

The [group's user-specified identifier](/v1/docs/group-group-information#group-id). This is mutually exclusive with the [Name tag](/v1/docs/api-getgroup#name). This is the GroupID returned by the [listGroups](/v1/docs/api-listgroups) method.

## API Response XML Package

The [API response XML package](/v1/docs/api-response-xml-package) will always include a Result, Info, and [Errors](/v1/docs/api-getgroup#error-codes) tag.

```markup
<SmarterU>
   <Result></Result>
   <Info>
      <Group>
         <Name><![CDATA[]]></Name>
         <GroupID><![CDATA[]]></GroupID>
         <CreatedDate><![CDATA[]]></CreatedDate>
         <ModifiedDate><![CDATA[]]></ModifiedDate>
         <Description><![CDATA[]]></Description>
         <HomeGroupMessage><![CDATA[]]></HomeGroupMessage>

         <NotificationEmails>
            <NotificationEmail><![CDATA[]]></NotificationEmail>
         </NotificationEmails>

         <UserCount></UserCount>
         <LearningModuleCount></LearningModuleCount>

         <Tags2>
            <Tag2>
               <TagID><![CDATA[]]></TagID>
               <TagName><![CDATA[]]></TagName>
               <TagValues><![CDATA[]]></TagValues>
            </Tag2>
         </Tags2>

         <Status><![CDATA[]]></Status>
      </Group>
   </Info>

   <Errors>
      <Error>
          <ErrorID></ErrorID>
          <ErrorMessage></ErrorMessage>
      </Error>
   </Errors>
</SmarterU>
```

The group is contained in a Group tag and may contain the following.

### Name

The [group's name](/v1/docs/group-group-information#name).

### GroupID

The [group's user-specified identifier](/v1/docs/group-group-information#group-id).

### CreatedDate

The [date the group was created](/v1/docs/adding-a-group).

### ModifiedDate

The [date the group was last modified](/v1/docs/editing-a-group).

### Description

The [group's description](/v1/docs/group-group-information#description).

### **HomeGroupMessage**

The [group's home group message](/v1/docs/group-home-group-message).

### **NotificationEmails**

A container for the [group's notification contacts](/v1/docs/group-group-information#send-completion-notifications-to). Each email address is contained in a NotificationEmail tag.

### UserCount

The number of [users assigned to the group](/v1/docs/group-users).

### **LearningModuleCount**

The number of [courses assigned to the group](/v1/docs/group-courses).

### **Tags2**

A container for the [group's tags](/v1/docs/group-tags). Each tag is contained in a Tag2 tag and may contain the following.

| Tag | Description |
| --- | --- |
| **TagID** | The tag's system-generated identifier. |
| **TagName** | The [tag's name](https://support.smarteru.com/v1/docs/tag-main#name). |
| **TagValues** | A comma-separated list of [tag values](https://support.smarteru.com/v1/docs/tag-pre-defined-values) associated with the group. |

### Example API Response XML Package

Below is an example of an API response XML package.

```markup
<SmarterU>
   <Result>Success</Result>
   <Info>
      <Group>
         <Name><![CDATA[Retail]]></Name>
         <GroupID><![CDATA[G-3039]]></GroupID>
         <CreatedDate><![CDATA[1900-01-01 05:00:00.0]]></CreatedDate>
         <ModifiedDate><![CDATA[2018-06-04 20:09:55.293]]></ModifiedDate>
         <Description><![CDATA[<p>A group for all Fina retail employees and team members.</p>]]></Description>
         <HomeGroupMessage><![CDATA[<p><span style="color: #3366ff;"><strong>Welcome to the Retail group!</strong></span></p>
         <p>Spring is here and so are our latest styles. Learn more about Fina's Spring 2018 collection today!</p>]]></HomeGroupMessage>
         <NotificationEmails> 
            <NotificationEmail><![CDATA[marie.vasquez@finashoe.com]]></NotificationEmail>
         </NotificationEmails>
         <UserCount>36</UserCount>
         <LearningModuleCount>96</LearningModuleCount>
 
         <Tags2> 
            <Tag2>
               <TagID>670</TagID>
               <TagName><![CDATA[Group Tags]]></TagName> 
               <TagValues> 
                  <![CDATA[Europe,North America]]>
               </TagValues>
            </Tag2>
         </Tags2>
         <Status><![CDATA[Active]]></Status>
      </Group>
   </Info>
 
   <Errors>
 
   </Errors>
</SmarterU>
```

## **Error Codes**

| Error Code | Message |
| --- | --- |
| GG:01 | The name provided is not valid. |
| GG:02 | The required permissions are not met to call the getGroup method. |
| GG:03 | The requested group does not exist. |
| GG:04 | The group ID provided is not valid. |

## Related

- [API: listGroups](/api-listgroups.md)
- [Groups](/groups.md)