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 Brief Member Information Under Department

    # 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
    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

    {
      "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;
    Get User Roles
    Get Department Members Details

    ← Get User Roles Get Department Members Details →

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