Description

Retrieve the list of user groups

Request Specification

Method: POST + application/json

Endpoint: https://${Enter cloud domain}/cgi/crm/v2/special/usergroupList?thirdTraceId=${Random String}

Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
includeNull	Boolean	No	Whether to include null fields. false: not returned, true: returned. Default is false
data	Map	Yes	Dataset

Request Example

{
  "includeNull": true,
  "data": {}
}

Response Parameters

Parameter	Type	Description
traceId	string	Request unique ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	View error codes
data	List	Dataset

Response Example

{
  "traceId": "E-O.827xxxxxx",
  "errorDescription": "success",
  "errorMessage": "OK",
  "errorCode": 0,
  "data": [
    {
      "groupId": "1111111111",
      "groupName": "AAA Manager",
      "description": ""
    },
    {
      "groupId": "2222222222",
      "groupName": "Dealer Report Subscription Push - Regional BBB Manager",
      "description": ""
    }
  ]
}

Notes

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