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

        • Get Users By Major Role
        • Add Role
        • Batch Add User Roles Incremental
        • Delete Role
        • Get Users By Role
          • Get Role List
          • Delete Role Members
          • Update Role Info
          • Batch Set User Roles Override
          • Get User Roles
        • Personnel API

        • User Group API

      • Other API

    • SSO Integration

    • Client Development

    • FAQ

    Table of Contents

    Get Users by Role

    # Description

    Retrieve corresponding users by role.

    # Request Specification

    Method: POST + application/json

    Endpoint: https://${cloud-domain}/cgi/crm/v2/bi/lwt/query?thirdTraceId=${Random String}

    Headers: Refer to Common Parameters

    # Request Parameters

    Parameter Type Required Description
    data Map Yes Dataset
      AuthContext Map No Application context
      roleCodes List Yes Role codes

    # Request Example

    {
      "data": {
        "AuthContext": {},
        "roleCodes": [
          "00000000000006"
        ]
      }
    }
    

    # Response Parameters

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

    # Response Example

    {
      "traceId": "E-O.827xxxxxx",
      "errorDescription": "success",
      "errorMessage": "OK",
      "errorCode": 0
    }
    

    # Notes

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

    ← Delete Role Get Role List →

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