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

      • Object Description API

        • Query Object Description
        • Query Object List
        • Approval Process API

        • Custom Function API

        • Lock Unlock API

        • Related Team API

        • Currency API

        • Business Process API

        • Stage Progression API

        • product Categories API

        • Other Common API

      • Address Book API

      • Other API

    • SSO Integration

    • Client Development

    • FAQ

    Table of Contents

    Query Object List

    # Description

    Query object list

    # Request Specification

    Request Method: POST + application/json

    Request Path: https://${Cloud Domain}/cgi/crm/v2/object/list?thirdTraceId=${Random String}

    Request Headers: Refer to Common Parameters

    # Request Parameters

    Parameter Type Required Description

    # Request Example

    {
    }
    

    # Response Parameters

    Parameter Type Description
    traceId string Request unique ID
    errorDescription string Error description
    data Map Response dataset
      objects List Object list

    # Response Example

    {
      "traceId": "E-O.cdklrj.2121-20251124113618-b6a1cb",
      "errorDescription": "success",
      "data": {
        "objects": [
          {
            "describeApiName": "MarketingEventObj",
            "describeDisplayName": "Marketing Event",
            "defineType": "package",
            "isActive": true,
            "hideButton": false,
            "publicObject": false
          },
          {
            "describeApiName": "CampaignMembersObj",
            "describeDisplayName": "Campaign Members",
            "defineType": "package",
            "isActive": true,
            "hideButton": false,
            "publicObject": false
          },
          {
            "describeApiName": "LeadsObj",
            "describeDisplayName": "Leads",
            "defineType": "package",
            "isActive": true,
            "iconPath": "",
            "iconIndex": 0,
            "hideButton": false,
            "publicObject": false
          },
          {
            "describeApiName": "BehaviorRecordObj",
            "describeDisplayName": "Behavior Record",
            "defineType": "package",
            "isActive": true,
            "hideButton": false,
            "publicObject": false
          },
          {
            "describeApiName": "AccountObj",
            "describeDisplayName": "Account",
            "defineType": "package",
            "isActive": true,
            "iconPath": "",
            "iconIndex": 0,
            "hideButton": false,
            "publicObject": false
          },
          {
            "describeApiName": "ContactObj",
            "describeDisplayName": "Contact",
            "defineType": "package",
            "isActive": true,
            "iconPath": "",
            "iconIndex": 0,
            "hideButton": false,
            "publicObject": false
          }
        ]
      }
    }
    
    Query Object Description
    Query Approval Definitions

    ← Query Object Description Query Approval Definitions →

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