Zoho crm Logo

使用外部 ID 搜索记录

目的

使用外部字段检索符合您的搜索条件的记录。

请求详情

请求 URL

https://www.zohoapis.com/crm/{version}/{module_api_name}/search

支持的模块

潜在客户,Account,联系人,交易,活动,任务,案例,事件,通话,解决方案,产品,Vendors,价格表,报价单,Sales Orders,采购Orders,Invoices,自定义,备注,预约,服务和活动

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

X-EXTERNAL: {module_API_name}.{external_field_API_name}

范围

scope=ZohoCRM.modules.all
(或)
scope=ZohoCRM.modules.{module_name}.{operation_type}
(和)
scope=ZohoSearch.securesearch.READ

可能的模块名称

线索、账户、联系人、交易、活动、任务、案例、事件、电话、解决方案、产品、供应商、价格表、报价单、销售订单、采购订单、发票、自定义、备注、预约、服务和活动

可能的操作类型

全部 - 完全访问记录
读取 - 从模块中获取记录

在“criteria”中使用外部值和“in”运算符
  • 参数:criteria=(External_Contact_ID:in:usercontact2,usercontact123)

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts/search?criteria=(External_Contact_ID:in:usercontact2,usercontact123)&fields=External_Contact_ID,Email"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-H "X-EXTERNAL: Contacts.External_Contact_ID"

示例响应

Copied{
    "data": [
        {
            "Email": "crm@external1.com",
            "External_Contact_ID": "usercontact123",
            "id": "111111000000146004"
        },
        {
            "Email": "crm@external.com",
            "External_Contact_ID": "usercontact2",
            "id": "111111000000101018"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}
在“criteria”中使用外部值和“equals”运算符
  • 参数:criteria=(External_Contact_ID:equals:usercontact123)

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts/search?criteria=(External_Contact_ID:equals:usercontact2)&fields=External_Contact_ID,Email"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-H "X-EXTERNAL: Contacts.External_Contact_ID"

示例响应

Copied{
    "data": [
        {
            "Email": "crm@external1.com",
            "External_Contact_ID": "usercontact123",
            "id": "111111000000146004"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}