Description

Retrieve brief member information under a specified department.

Request Specification

Method: POST + application/json

Endpoint: https://${cloud-domain}/cgi/user/simpleList?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
departmentId	Int	Yes	Department ID (non-negative integer). 999999 represents the entire company
fetchChild	Boolean	No	true: Get employees from all sub-departments; false(default): Only get current department employees

Request Example

{
  "includeNull": true,
  "departmentId": 1000,
  "fetchChild": false
}

Response Parameters

Parameter	Type	Description
userList	List	Member information list
openUserId	string	openUserId
name	string	Name
nickName	string	Nickname
traceId	string	Request unique ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error codes

Response Example

{
  "userList": [
    {
      "openUserId": "FSUID_39E2Bxxxxxxx",
      "name": "Xiao Ming",
      "nickName": "Xiao Ming"
    },
    {
      "openUserId": "FSUID_B4D44xxxxxxx",
      "name": "Xiao Hong",
      "nickName": "Xiao Hong"
    }
  ],
  "traceId": "E-O.827xxxxxx",
  "errorCode": 0,
  "errorMessage": "success",
  "errorDescription": "Success"
}

Notes

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