Get Group List
Call Instructions:
This interface is used to query all groups
This interface is called only by system administrators
Interface Information | |||
---|---|---|---|
Name | Get group list | ||
Address | /rest/tools/1.0/api/group/getGroupList | ||
Method | GET | ||
Return Type | Json | ||
Authentication | Basic,token | ||
Parameters | |||
Parameter name | Required | Parameter type | Description |
groupName | N | String | group name, support fuzzy query, case-insensitive |
page | N | int | Paging parameter, offset, defaults to 0 |
pageSize | N | int | Page parameter, number of lines, maximum limit 100, default 10 |
return value format | |||
Field | Type | Description | |
code | int | ||
msg | String | ||
total | int | Total data | |
isMore | bool | true or false | |
data | String | [{ |
Example Postman call
Example return value
{
"code": 0,
"msg": "Success",
"total": 3,
"isMore": false,
"data": [
{
"name": "confluence-administrators"
},
{
"name": "confluence-users"
},
{
"name": "sales"
}
]
}