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

      • User Group API

        • Add User Group
        • Add Users To Group Incremental
        • Update User Group Users Override
        • Get User Group List
          • Delete User Group
          • Get Group User List
      • Other API

    • SSO Integration

    • Client Development

    • FAQ

    Table of Contents

    Get User Group List

    # Description

    Retrieve the list of user groups

    # Request Specification

    Method: POST + application/json

    Endpoint: https://${Enter cloud domain}/cgi/crm/v2/special/usergroupList?thirdTraceId=${Random String}

    Headers: Refer to Common Parameters

    # Request Parameters

    Parameter Type Required Description
    data Map Yes Dataset

    # Request Example

    {
      "data": {}
    }
    

    # Response Parameters

    Parameter Type Description
    traceId string Request unique ID
    errorDescription string Error description
    errorMessage string Error message
    errorCode Int View error codes
    data List Dataset

    # Response Example

    {
      "traceId": "E-O.827xxxxxx",
      "errorDescription": "success",
      "errorMessage": "OK",
      "errorCode": 0,
      "data": [
        {
          "groupId": "1111111111",
          "groupName": "AAA Manager",
          "description": ""
        },
        {
          "groupId": "2222222222",
          "groupName": "Dealer Report Subscription Push - Regional BBB Manager",
          "description": ""
        }
      ]
    }
    

    # Notes

    • Do not use the message field in the response for logical judgments, as errorMessage may change;
    Update User Group Users Override
    Delete User Group

    ← Update User Group Users Override Delete User Group →

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