Path: /api/v1/group/list
Method: GET
Description:Query group information, including group ID and group name. The group ID is used for assigning profiles to groups when creating them, and group ID 0 is the default group created by the system.
Optional parameters in the query can be omitted.
| Name | Necessary | Default | Example | Description |
|---|---|---|---|---|
| group_name | NO | - | group1 | Enter a group name and search. If it is empty, system will search all groups. |
| page | NO | 1 | 1 | Set from page 1 by default |
| page_size | NO | 1 | 10 | 1 piece of data per page by default, max. 2000 |
//Operation succeeded
{
"code": 0,
"data": {
"list": [
{
"group_id": "100", //Group ID, used to add account
"group_name": "group1", //Group name
"remark": "xxxxx" //Group remark
},
{
"group_id": "101",
"group_name": "group2",
"remark": "xxxxx" //Group remark
}
],
"page": 1,
"page_size": 10
},
"msg": "Success"
}
//Operation failed
{
"code":-1,
"data":{},
"msg":"failed"
}