---
title: "API: listUsersCounts"
slug: "api-listuserscounts"
updated: 2022-09-22T17:36:06Z
published: 2022-09-22T17:36:06Z
canonical: "support.smarteru.com/api-listuserscounts"
---

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

- SmarterU requires 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 listUsersCounts method retrieves the count of [actions by status](/v1/docs/action-status-summary) for a user.

## Who Has Access

The following users have access to the listUsersCounts method:

- Users with the [Group Manager](/v1/docs/group-permission-group-manager-gm), or [View Learner Results](/v1/docs/group-permission-view-learner-results-vlr) group permission.
- [Supervisors](/v1/docs/adding-and-removing-supervisors), if the account's [**Supervisor Access** setting's](https://support.smarteru.com/docs/supervisor-access#report-on-supervisees)*Report on Supervisees* option is checked.
- [Administrators and owners](https://support.smarteru.com/v1/docs/user-profile-information#access-level).

## API Call XML Package

```markup
<SmarterU>
   <AccountAPI><![CDATA[]]></AccountAPI>
   <UserAPI><![CDATA[]]></UserAPI>
   <Method>createUser</Method>
   <Parameters>
      <User>
         <Filters>
            <Users>
               <UserIdentifier>
                  <ID></ID>
                     - OR -
                  <Email></Email>
                     - OR -
                  <EmployeeID></EmployeeID>
               </UserIdentifier>
            </Users>
         </Filters>
      </User>
   </Parameters>
</SmarterU>
```

## User Tag Group

The User tag group is a container for the user filters.

```markup
<User>
   <Filters>
      <Users>
         <UserIdentifier>
            <ID></ID>
               - OR -
            <Email></Email>
               - OR -
            <EmployeeID></EmployeeID>
         </UserIdentifier>
      </Users>
   </Filters>
</User>
```

The User tag includes the following.

### Filters

A container for the filters. Refer to [Filters Tag Group](/v1/docs/api-listuserscounts#filters-tag-group).

## Filters Tag Group

A container for the filters you want to apply.

```markup
<Filters>
   <Users>
      <UserIdentifier>
         <ID></ID>
         <Email></Email>
         <EmployeeID></EmployeeID>
      </UserIdentifier>
   </Users>
</Filters>
```

The Filters tag must contain the following.

### Users

A container for user filters. Each user is contained in a UserIdentifier tag and contains the following.

| Tag | Description |
| --- | --- |
| **ID** | The user's system-generated identifier. This tag is mutually exclusive with the [Email](/v1/docs/api-listuserscounts#email) and [EmployeeID](/v1/docs/api-listuserscounts#employeeid) tags. This is the ID returned by the [getUser](/v1/docs/api-getuser) and [listUsers](/v1/docs/api-listusers) methods. |
| **Email** | The [user's email address](https://support.smarteru.com/docs/user-login-information#primary-email-required-if-employee-id-not-specified). This tag is mutually exclusive with the [ID](/v1/docs/api-listuserscounts#id) and [EmployeeID](/v1/docs/api-listuserscounts#employeeid) tags. This is the Email returned by the [getUser](/v1/docs/api-getuser) and [listUsers](/v1/docs/api-listusers) methods. |
| **EmployeeID** | The [user's employee ID](https://support.smarteru.com/docs/user-login-information#employee-id-required-if-primary-email-not-specified). This tag is mutually exclusive with the [ID](/v1/docs/api-listuserscounts#id) and [Email](/v1/docs/api-listuserscounts#email) tags. This is the EmployeeID returned by the [getUser](/v1/docs/api-getuser) and [listUsers](/v1/docs/api-listusers) methods. |

## 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-listuserscounts#error-codes) tag.

```markup
<SmarterU>
   <Result></Result>
   <Info>
      <Users>
         <User>
            <ID><![CDATA[]]></ID>
            <Email><![CDATA[]]></Email>
            <EmployeeID><![CDATA[]]><EmployeeID/>
            <Actions>
               <Total></Total>
               <Accepted></Accepted>
               <Review></Review>
               <Pending></Pending>
            </Actions>
         </User>
      </Users>
   </Info>

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

The response may contain the following.

### Users

The Users tag is a container for the users returned by the listUsersCounts method. Each user is contained in a User tag and may contain the following.

| Tag | Description |
| --- | --- |
| **ID** | The user's system-generated identifier. |
| **Email** | The [user's email address](https://support.smarteru.com/docs/user-login-information#primary-email-required-if-employee-id-not-specified). |
| **EmployeeID** | The [user's employee ID](https://support.smarteru.com/docs/user-login-information#employee-id-required-if-primary-email-not-specified). |
| **Actions** | A container for the count of actions for the user. The tag contains the following: - Total - The total number of actions assigned to the user. - Accepted - The number of actions assigned to the user that have been confirmed. - Review - The number of actions assigned to the user that are awaiting for activity from someone else. - Pending - The number of actions assigned to the user that are awaiting activity from the user. |

### Example API Response XML Package

Below is an example of an API response XML package.

```markup
<SmarterU>
   <Result>Success</Result>
   <Info>
      <Users>
         <User>
            <ID><![CDATA[922822]]></ID>
            <Email><![CDATA[anna.cruz@finashoes.com]]></Email>                        
            <EmployeeID><![CDATA[10012]]></EmployeeID>
            <Actions>
              <Total>2</Total>
              <Accepted>1</Accepted>
              <Review>1</Review>
              <Pending>0</Pending>
           </Actions>
         </User>

         <User>
            <ID><![CDATA[923053]]></ID>
            <Email><![CDATA[dana.brown@finashoes.com]]></Email> 
            <EmployeeID><![CDATA[193847]]></EmployeeID>
            <Actions>
               <Total>3</Total>
               <Accepted>0</Accepted>
               <Review>0</Review>
               <Pending>3</Pending>
            </Actions>
         </User>
      </Users>
   </Info>

   <Errors>
   </Errors>
</SmarterU>
```

## Error Codes

| Error Code | Message |
| --- | --- |
| LUC:01 | The filters provided is invalid. |
| LUC:02 | The users provided is invalid. |
| LUC:03 | The ID provided is invalid. |
| LUC:04 | The email provided is invalid. |
| LUC:05 | The employee ID provided is invalid. |
| LUC:06 | The required permissions are not met to call the listUsersCounts method. |