---
title: "API: getGroupLearningModules"
slug: "api-getgrouplearningmodules"
updated: 2022-08-25T19:34:25Z
published: 2022-08-25T19:34:25Z
canonical: "support.smarteru.com/api-getgrouplearningmodules"
---

> ## 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: getGroupLearningModules

- 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 getGroupLearningModules method retrieves the [group's courses](/v1/docs/group-courses).

## **Who Has Access**

The following users have access to the getGroupLearningModules 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.
- Users with the [Create New Group](/v1/docs/account-permission-create-new-group) account permission.
- [Administrators and owners](/v1/docs/user-profile-information#access-level).

## **API Call XML Package**

```markup
<SmarterU>
   <AccountAPI><![CDATA[]]></AccountAPI>
   <UserAPI><![CDATA[]]></UserAPI>
   <Method>getGroupLearningModules</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 may contain the following.

### **Name**

The [group's name](/v1/docs/group-group-information#name). This tag is mutually exclusive with the [](https://help.smarteru.com/api-getgrouplearningmodules$group_tag_group_GroupId)[GroupID tag](/v1/docs/api-getgrouplearningmodules#groupid). This is the Name returned by the [](https://help.smarteru.com/api-getgroup$api_response_xml_package)[getGroup](/v1/docs/api-getgroup) method.

### **GroupID**

The [group's user-specified identifier](/docs/group-group-information#group-id). This tag is mutually exclusive with the [](https://help.smarteru.com/api-getgrouplearningmodules$group_tag_group_Name)[Name tag](/v1/docs/api-getgrouplearningmodules#name). This is the GroupID returned by the [getGroup](/v1/docs/api-getgroup) 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-getgrouplearningmodules#error-codes) tag.

```markup
<SmarterU>
   <Result></Result>
   <Info>
      <LearningModules>
         <LearningModule>
            <LearningModuleID><![CDATA[]]></LearningModuleID>
            <Name><![CDATA[]]></Name>
            <Type><![CDATA[]]></Type>
            <Status><![CDATA[]]></Status>
         </LearningModule>
      </LearningModules>
   </Info>

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

The LearningModules tag is a container for the courses returned by the getGroupLearningModules method. Each course is contained in a LearningModule tag and may contain the following.

### **LearningModuleID**

The course's system-generated identifier.

### **Name**

The course's name.

### **Type**

The course type (i.e., Online, SCORM, or External).

### **Sta****tus**

The course's status (i.e., Active, Inactive, Archived).

### Example API Response XML Package

Below is an example of an API response XML package.

```markup
<SmarterU>
   <Result>Success</Result>
   <Info>
      <LearningModules>
         <LearningModule>
            <LearningModuleID><![CDATA[1972]]></LearningModuleID>
            <Name><![CDATA[Employee Onboarding]]></Name>
            <Type><![CDATA[Online]]></Type>
            <Status><![CDATA[Active]]></Status>
         </LearningModule>

         <LearningModule>
            <LearningModuleID><![CDATA[3860]]></LearningModuleID>
            <Name><![CDATA[Forklift Operation]]></Name>
            <Type><![CDATA[External]]></Type>
            <Status><![CDATA[Active]]></Status>
         </LearningModule>
      </LearningModules>
   </Info>

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

## **Error Codes**

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

## Related

- [API: createGroup](/api-creategroup.md)
- [API: getGroup](/api-getgroup.md)
- [API: listGroups](/api-listgroups.md)
- [API: updateGroup](/api-updategroup.md)
- [Group: Courses](/group-courses.md)
- [Groups](/groups.md)