Description

Retrieve the role list.

Request Specification

Method: POST + application/json

Path: https://${cloud domain}/cgi/crm/v2/special/roleGetRoleList?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
AuthContext	Map	Yes	Application information
appId	String	Yes	Application ID

Request Example

{
  "includeNull": true,
  "data": {
    "AuthContext": {
      "appId": "CRM"
    }
  }
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error codes
data	List	Dataset

Response Example

{
  "traceId": "E-O.827xxxxxx",
  "errorDescription": "success",
  "errorMessage": "OK",
  "errorCode": 0,
  "data": [
    {
      "groupName": "Sales Role",
      "roleCode": "00000000000000001",
      "roleName": "Sales Personnel",
      "roleType": 1,
      "appId": "CRM",
      "description": "Predefined sales-related function permissions for sales personnel",
      "delFlag": false
    },
    {
      "groupName": "Finance Role",
      "roleCode": "00000000000002",
      "roleName": "Refund Finance",
      "roleType": 1,
      "appId": "CRM",
      "description": "Permissions related to refund finance",
      "delFlag": false
    }
  ]
}

Notes

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