# List the users included in the user group - ListUsersForGroup

## Overview

List the users included in the user group






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListUsersForGroup`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.scloudsg.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **GroupName** | string | User Group Name |**Yes**|
| **Limit** | string | The number of users within the group to be queried |No|
| **Offset** | string | Start querying from which data entry |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **Users** | array[[*UserForGroup*](#userforgroup)] | User Information Array |**Yes**|
| **TotalCount** | int | Total |**Yes**|

#### Data Model


#### UserForGroup

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Email** | string | Email |**Yes**|
| **UserName** | string | Username |**Yes**|
| **DisplayName** | string | Nickname |No|
| **JoinedAt** | int | Timestamp when the user is added to the user group |No|

## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=ListUsersForGroup
&GroupName=KuKDjeCr
&Limit=JQyYOWCO
&Offset=PrpveeyA
```

### Response Example
    
```json
{
  "Action": "ListUsersForGroupResponse",
  "Message": "XECMcnes",
  "RetCode": 0,
  "TotalCount": 8,
  "Users": [
    {
      "CreateAt": 6,
      "DisplayName": "nEiDkUhx",
      "Email": "yDPYuLBl",
      "JoinedAt": "EWhIPVXP",
      "Status": "yes",
      "UserName": "NWwNBOgF"
    }
  ]
}
```