Fxiaoke Developer Manual Fxiaoke Developer Manual
  • APL Development Manual
  • PWC Development Manual
  • OpenAPI Documentation
  • Quick Start
  • API Authorization
  • API Basics
  • OpenAPI
  • SSO Integration
  • Client Development
  • FAQ
  • OpenApi Version V1 (opens new window)
  • 简体中文
  • English
  • Quick Start
  • API Authorization
  • API Basics
  • OpenAPI
  • SSO Integration
  • Client Development
  • FAQ
  • OpenApi Version V1 (opens new window)
  • 简体中文
  • English
  • Quick Start

  • API Authorization

  • API Basics

  • OpenAPI

    • CRM Object API

    • CRM Common API

    • Address Book API

      • Personnel Role API

      • Personnel API

        • Get Department Members Brief
        • Get Department Members Details
        • User Group API

      • Other API

    • SSO Integration

    • Client Development

    • FAQ

    Table of Contents

    Get Department Member Details

    # Description

    Retrieve detailed member information under a department.

    # Request Specification

    Method: POST + application/json

    Endpoint: https://${Cloud Domain}/cgi/user/list?thirdTraceId=${Random String}

    Headers: Refer to Common Parameters

    # Request Parameters

    Parameter Type Required Description
    departmentId Int Yes Department ID
    fetchChild Boolean Yes If true, retrieves employees from all child departments; if false or omitted, only retrieves current department employees
    showDepartmentIdsDetail Boolean Yes If true, returns the employee's main department (mainDepartmentId) and affiliated departments (attachingDepartmentIds)

    # Request Example

    {
      "departmentId": 1,
      "showDepartmentIdsDetail": false,
      "fetchChild": false
    }
    

    # Response Parameters

    Parameter Type Description
    userList List Member information list
    traceId string Request unique ID
    errorDescription string Error description
    errorMessage string Error message
    errorCode Int Error Codes

    # Response Example

    {
      "userList": [
        {
          "openUserId": "FSUID_294CDxxxxxxx",
          "account": "111",
          "name": "Xiao Ming",
          "nickName": "Xiao Ming",
          "isStop": false,
          "email": "xiaoming@qq.com",
          "mobile": "15611110000",
          "gender": "M",
          "position": "Sales Manager",
          "profileImageUrl": "",
          "departmentIds": [111111, 1001, 0000],
          "qq": "",
          "weixin": "",
          "employeeNumber": "111",
          "hireDate": "2023-03-16",
          "birthDate": "",
          "startWorkDate": "",
          "createTime": 1758789217451,
          "leaderId": "FSUID_64121xxxxxxx"
        },
        {
          "openUserId": "FSUID_D1EA4xxxxxxx",
          "account": "112",
          "name": "Xiao Hong",
          "nickName": "Xiao Hong",
          "isStop": false,
          "email": "xiaohong@qq.com",
          "mobile": "13711110000",
          "gender": "M",
          "position": "Sales Representative",
          "profileImageUrl": "",
          "departmentIds": [111111, 1001, 0000],
          "qq": "",
          "weixin": "",
          "employeeNumber": "112",
          "hireDate": "2023-03-16",
          "birthDate": "",
          "startWorkDate": "",
          "createTime": 1757488133344,
          "leaderId": "FSUID_92E68xxxxxxxx"
        }
      ],
      "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;
    Get Department Members Brief
    Add User Group

    ← Get Department Members Brief Add User Group →

    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式