Description

Query all user groups under a specified business line.

Request Specification

Method: POST + application/json
Path: https://${Cloud Domain}/cgi/crm/v2/org/group?thirdTraceId=${Random String} Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
data	Map	Yes	Data map
appId	String	Yes	Fixed value: CRM
isFilterByUser	Boolean	Yes	Whether to filter groups by createdBy using the userId from context
isPublic	Boolean	Yes	Whether the group is public
status	Int	Yes	User group status: 0-enabled, 1-disabled
page	Map	Yes	Pagination parameters
pageSize	Int	Yes	Page size
currentPage	Int	Yes	Page number

Request Example

{
  "data": {
    "isFilterByUser": true,
    "appId": "CRM",
    "isPublic": true,
    "page": {
      "pageSize": 20,
      "currentPage": 1
    },
    "status": 0
  }
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error Codes

Response Example

{
  "traceId": "E-O.827xxxxxx",
  "errorDescription": "success",
  "errorMessage": "OK",
  "errorCode": 0
}

Notes

• Do not use the message field in the response for logical judgment, as errorMessage may change.