Skip to content
API Reference
/
/
/
Get a list of groups

Get a list of groups

Request

List profile groups, page by page.

  • Effect: none. Read-only. Safe to retry with bounded backoff.
  • Note: when the team authorizes access per group, a member who has no group grants receives an empty page rather than an error.
Bodyapplication/json
groupNamestring(Group name (partial match))required
pageNointeger(Current page)required
pageSizeinteger(Items per page)required
POST
/api/envgroup/page
curl -i -X POST \
  http://127.0.0.1:40000/api/envgroup/page \
  -H 'Content-Type: application/json' \
  -d '{
    "groupName": "132-kernel",
    "pageNo": 1,
    "pageSize": 10
  }'

Responses

Success. data.dataList holds the records for the requested page and is an empty array when there are no matches; data.total, data.current and data.pages describe the paging.

Headers
any
Bodyapplication/json
codeintegerrequired

Return result code 0:Normal Other codes are exceptions.

msgstring or nullrequired

Error message

dataobjectrequired
requestIdstringrequired

Operation Request ID

Response
{
  "code": 0,
  "msg": "",
  "data": {
    "current": "0",
    "dataList": [ … ],
    "pages": "0",
    "total": "0"
  },
  "requestId": ""
}