# List User Groups - ListGroups

## Overview

List User Groups






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListGroups`.                      | **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 |
|:---|:---|:---|:---|

### 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|
| **Groups** | array[[*Group*](#group)] | User Group Array |**Yes**|
| **TotalCount** | int | Total |**Yes**|

#### Data Model


#### Group

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **GroupName** | string | User Group Name |**Yes**|
| **Description** | string | User Group Description Information |**Yes**|
| **CreatedAt** | int | User Group Creation Timestamp |No|

## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=ListGroups
```

### Response Example
    
```json
{
  "Action": "ListGroupsResponse",
  "Groups": [
    {
      "CreateAt": 7,
      "Description": "ftZJOUpz",
      "GroupName": "Zgriftqa",
      "JoinedAt": "OsVugnMn"
    }
  ],
  "Message": "hwocmdDy",
  "RetCode": 0,
  "TotalCount": 8
}
```