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

      • 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

        • Get Countries
        • Query Update Records
        • Update Group Members
        • Add Tags
        • Query Object Data
          • CRM Journal Query
          • Query All Groups
          • Query Available Tags
          • Add Group
          • Query Single Record
      • Address Book API

      • Other API

    • SSO Integration

    • Client Development

    • FAQ

    Table of Contents

    Query Object Data by Conditions (Basic Query Only)

    # Description

    Query object data based on specified conditions, performing only basic data queries.

    # Request Specification

    Method: POST + application/json

    Endpoint: https://${Cloud Domain}/cgi/crm/custom/v2/data/findSimple?thirdTraceId=${Random String}

    Headers: Refer to Common Parameters

    # Request Parameters

    Parameter Type Required Description
    data Map Yes Data map
      dataObjectApiName String Yes Object's API name
      find_explicit_total_num Boolean No Whether to return total count (true → returns total; false → skips total count. Default: true. Setting false improves response speed)
      search_query_info Map Yes Query Conditions
        limit Int Yes Pagination size (max: 100)
        offset Int Yes Offset (starts from 0; must be a multiple of limit)
        filters List Yes Filter conditions list
          field_name String Yes Field name
          field_values List[String] Yes Field values
          operator String Yes Operator (see Operator Parameters below)
        orders List Yes Query conditions
          fieldName String Yes Field name
          isAsc Boolean Yes Sort order (true: ascending; false: descending)
        field-projection List[String] Yes Fields to return (empty returns all fields). Calculated/statistical/reference fields won't be computed in real-time

    # Request Example

    {
      "data": {
        "search_query_info": {
          "offset": "0",
          "limit": "10",
          "orders": [
            {
              "fieldName": "last_modified_time",
              "isAsc": "false"
            }
          ],
          "filters": {
            "operator": "GT",
            "field_name": "last_modified_time",
            "field_values": "[1744094120158]"
          }
        },
        "dataObjectApiName": "",
        "igonreMediaIdConvert": false,
        "field_projection": [
          "_id"
        ]
      }
    }
    

    # Response Parameters

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

    # Response Example

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

    # Notes

    • Do not use the message field in responses for logical judgments, as errorMessage may change.
    Add Tags
    CRM Journal Query

    ← Add Tags CRM Journal Query →

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