搜索记录
目的
要在单个模块中检索符合您的搜索条件的记录。
请求详情
请求 URL
{api-domain}/crm/{version}/{module_api_name}/search
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.modules.{module_name}.{operation_type}
(和)
scope=ZohoSearch.securesearch.READ
可能的模块名称
线索、账户、联系人、用户、交易、活动、任务、案例、事件、电话、解决方案、产品、供应商、价格表、报价单、销售订单、采购订单、发票、自定义、备注、预约、预约重新安排历史和服务。
可能的操作类型
全部 - 完全访问记录
读取 - 从模块获取记录
端点
- GET /{module_api_name}/search?criteria={{criteria_here}}
- GET /{module_api_name}/search?email={{email_here}}
- GET /{module_api_name}/search?phone={{phone_number_here}}
- GET /{module_api_name}/search?word={{search_word_here}}
- {module_api_name} : 您想要搜索其记录的模块的 API 名称。
请求详情:标准
| 请求 URL: | {api-domain}/crm/v8/{module_api_name}/search?criteria={criteria_here} |
参数
- 标准字符串
- 按照所示标准执行搜索。(({api_name}:{operator}:{value})and/or({api_name}:{operator}:{value}))
- 根据以下格式执行搜索:
- (({field_API_name}:{operator}:{value}) 和/或 ({field_API_name}:{operator}:{value}))
- 用适当的字段 API 名称、条件和值替换 {field_API_name}、{operator} 和 {value}。
- 您最多可以搜索10个条件(相同或不同的列)。
- 唯一支持加密字段的操作符是等于。
- 在使用搜索 API 中的等于操作符时,它的行为类似于包含,检索包含指定值的记录。
- 对于单个条件,如果条件是(Company:equals:ABC),响应将包括在Company字段中包含"ABC"以及"ABC Inc"的记录。
- 对于多个条件,equals仍然表现得像contains。
例如,((Company:equals:ABC) and (First_Name:starts_with:M)),它检索"First Name"以"M"开头且"Company"包含"ABC"(例如,"ABC"或"ABC Inc.")的记录。
注意:上述行为不适用于选择列表字段类型。
- "in" 操作符检查字段的值是否与给定列表中的任何值匹配。
- 例如,(Full_Name:in:Patricia,Boyle,Kate),它检索 Full Name 为 Patricia、Boyle 或 Kate 的记录。
- 当单行字段值包含字符如 "{"、"}"、"["、"]"、"^"、":"、"-"、"/"、"!"、"?"、"*"、"_"、"@"、空格 时,搜索 API 会返回具有相似值的记录,即使这些字符不完全匹配。
- 例如,如果记录 A 的字段值为 sales-team@zoho.com,而记录 B 的字段值为 sales_team@zoho.com,使用 equals:sales-team@zoho.com 进行搜索可能会返回两个记录。
- 当使用括号(())、逗号(,)或反斜杠(\)作为搜索值的最后一个字符时,请按照以下步骤操作:
- 使用反斜杠(\)转义特殊字符。
在进行API请求之前,对值进行编码。选择条件的值,右键单击该值,然后选择EncodeURIComponent选项。
示例1:转义括号和逗号
搜索词:((Last_Name:equals:Burns,B) and (First_Name:starts_with:M))
- 转义逗号(\,):((Last_Name:equals:Burns\,B) and (First_Name:starts_with:M))
- 对值进行编码:((Last_Name:equals:Burns%5C%2CB) and (First_Name:starts_with:M))
示例2:转义结尾的反斜杠
搜索词:(Last_Name:equals:K\)
- 转义反斜杠(\\):(Last_Name:equals:K\\)
- 对值进行编码:(Last_Name:equals:K%5C%5C)
- 支持的数据类型有
- picklist
- owner_lookup
- user_lookup
- lookup
- phone
- date
- datetime
- text
- textarea
- integer
- currency
- decimal
- multiselectpicklist
- bigint
- percent
- formula
- website
- boolean
- double
支持的操作符有
- equals(等于)
- starts_with(以...开始)
- in(在...中)
- not_equal(不等于)
- greater_equal(大于等于)
- greater_than(大于)
- less_equal(小于等于)
- less_than(小于)
- between(在...之间)
请参阅以下“注意”部分,了解每种字段类型支持的操作符。
注意
以下部分为您提供了字段类型和您可以在条件参数中使用的运算符
- 日期, 日期时间 : 等于, 不等于, 大于等于, 大于, 小于等于, 小于, 介于, 在...之中.
- 整数, 货币, 小数 : 等于, 不等于, 大于等于, 大于, 小于等于, 小于, 介于, 在...之中.
- 布尔值 : 等于, 不等于.
- 多行文本 : 等于, 不等于, 以...开始.
- 查找(用户/所有者) : 等于, 不等于, 在...之中.
- 选择列表, 自动编号 : 等于, 不等于, 在...之中.
- 文本, Email, 电话, 网站 : 等于, 不等于, 以...开始, 在...之中.
- 多选列表 : 等于, 不等于, 在...之中, 以...开始.
- 大整数 : 等于, 不等于, 大于, 大于等于, 小于, 小于等于, 介于, 在...之中.
- 百分比 : 等于, 不等于, 大于, 大于等于, 小于, 小于等于, 介于, 在...之中.
- 公式 : 运算符取决于公式的返回类型. 请检查相应数据类型的支持运算符.
搜索请求示例及其条件
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/search?criteria=Created_Time%3Abetween%3A2024-02-01T18%3A52%3A56%2B00%3A00%2C2024-02-20T18%3A52%3A56%2B00%3A00"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"在此示例中,搜索 DateTime 字段的标准是使用当前用户时区的 ISO8601 格式。查询已编码。
示例响应
Copied{
"data": [
{
"Account": null,
"Company": "ABC",
"Owner": {
"name": "Patricia Boyle",
"id": "554023000000235011",
"email": "p.boyle@zylker.com"
},
"Email": null,
"$currency_symbol": "Rs.",
"$field_states": null,
"$sharing_permission": "full_access",
"Last_Activity_Time": null,
"Industry": null,
"Unsubscribed_Mode": null,
"$process_flow": true,
"Street": null,
"$locked_for_me": false,
"Zip_Code": null,
"id": "554023000003701012",
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Created_Time": "2024-02-19T18:30:23-11:00",
"$wizard_connection_path": null,
"$editable": true,
"City": null,
"No_of_Employees": null,
"Longitude": null,
"Converted_Account": null,
"State": null,
"Country": null,
"Created_By": {
"name": "Patricia Boyle",
"id": "554023000000235011",
"email": "p.boyle@zylker.com"
},
"$zia_owner_assignment": "owner_recommendation_unavailable",
"Secondary_Email": null,
"Annual_Revenue": null,
"Currency_1": null,
"Description": null,
"Rating": null,
"$review_process": {
"approve": false,
"reject": false,
"resubmit": false
},
"Website": null,
"Twitter": null,
"File_Upload": null,
"Associated_Contacts": null,
"Salutation": null,
"Co_Owner": null,
"Full_Name": "John Smith",
"First_Name": "John",
"Lead_Status": null,
"Record_Image": null,
"Converted_Deal": null,
"Modified_By": {
"name": "Patricia Boyle",
"id": "554023000000235011",
"email": "p.boyle@zylker.com"
},
"$review": null,
"Lead_Conversion_Time": null,
"Skype_ID": null,
"Phone": null,
"Image_Upload_1": null,
"Email_Opt_Out": false,
"$zia_visions": null,
"Designation": null,
"Modified_Time": "2024-02-19T18:30:23-11:00",
"$converted_detail": {},
"Unsubscribed_Time": null,
"Converted_Contact": null,
"Mobile": null,
"Record_Status__s": "Available",
"$orchestration": false,
"Last_Name": "Smith",
"Layout": {
"name": "Standard",
"id": "554023000000095055"
},
"$in_merge": false,
"Locked__s": false,
"Lead_Source": null,
"Tag": [],
"Fax": null,
"$approval_state": "approved",
"$pathfinder": false
}
],
"info": {
"per_page": 200,
"count": 1,
"sort_by": "id",
"page": 1,
"sort_order": "desc",
"more_records": false
}
}请求详情:电子邮件
| 请求 URL: | https://www.zohoapis.com/crm/v8/{module_api_name}/search?email={email_here} |
Attributes
- email string
使用电子邮件地址搜索记录。API 会在指定模块的所有电子邮件字段中进行搜索,并返回匹配的记录。
示例请求通过电子邮件搜索
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/search?email=newcrmapi@zoho.com"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"示例响应
Copied{
"data": [
{
"Account": null,
"Owner": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Company": null,
"Email": "newcrmapi@zoho.com",
"$currency_symbol": "Rs.",
"Visitor_Score": null,
"Last_Activity_Time": "2019-03-22T11:10:55+05:30",
"Industry": "ASP",
"$converted": false,
"$process_flow": false,
"Street": "Street",
"Zip_Code": "Zip_Code",
"id": "3652397000000415002",
"$approved": true,
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"First_Visited_URL": null,
"Days_Visited": null,
"Created_Time": "2019-01-10T13:04:32+05:30",
"$editable": true,
"City": "City",
"No_of_Employees": 100,
"State": "State",
"Country": "Country",
"Last_Visited_Time": null,
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Annual_Revenue": 100000,
"Secondary_Email": "newcrmapi@zoho.com",
"Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
"Number_Of_Chats": null,
"Rating": "Acquired",
"Website": "crm.zoho.com",
"Twitter": "Twitter",
"Average_Time_Spent_Minutes": null,
"Associated_Contacts": null,
"Salutation": "Mr.",
"First_Name": "First_Name",
"Lead_Status": "Contacted",
"Full_Name": "Mr. First_Name Last_Name",
"Record_Image": null,
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Skype_ID": "Skype_ID",
"Phone": "98883434559",
"Email_Opt_Out": false,
"Designation": "Designation",
"Modified_Time": "2019-03-22T11:10:55+05:30",
"$converted_detail": {},
"Mobile": "98883434559",
"Prediction_Score": null,
"First_Visited_Time": null,
"Last_Name": "Last_Name",
"Referrer": null,
"Lead_Source": "Twitter",
"Tag": [],
"Fax": "Fax"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
}请求详情:电话
| 请求 URL: | https://www.zohoapis.com/crm/v8/{module_api_name}/search?phone={phone_number_here} |
Attributes
- phone string
使用电话号码搜索记录。API在指定模块中跨所有电话字段进行搜索并返回匹配的记录。
样本请求通过电话搜索
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/search?phone=98883434559
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"示例响应
Copied{
"data": [
{
"Account": null,
"Owner": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Company": null,
"Email": "newcrmapi@zoho.com",
"$currency_symbol": "Rs.",
"Visitor_Score": null,
"Last_Activity_Time": "2019-03-22T11:10:55+05:30",
"Industry": "ASP",
"$converted": false,
"$process_flow": false,
"Street": "Street",
"Zip_Code": "Zip_Code",
"id": "3652397000000415002",
"$approved": true,
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"First_Visited_URL": null,
"Days_Visited": null,
"Created_Time": "2019-01-10T13:04:32+05:30",
"$editable": true,
"City": "City",
"No_of_Employees": 100,
"State": "State",
"Country": "Country",
"Last_Visited_Time": null,
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Annual_Revenue": 100000,
"Secondary_Email": "newcrmapi@zoho.com",
"Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
"Number_Of_Chats": null,
"Rating": "Acquired",
"Website": "crm.zoho.com",
"Twitter": "Twitter",
"Average_Time_Spent_Minutes": null,
"Associated_Contacts": null,
"Salutation": "Mr.",
"First_Name": "First_Name",
"Lead_Status": "Contacted",
"Full_Name": "Mr. First_Name Last_Name",
"Record_Image": null,
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Skype_ID": "Skype_ID",
"Phone": "98883434559",
"Email_Opt_Out": false,
"Designation": "Designation",
"Modified_Time": "2019-03-22T11:10:55+05:30",
"$converted_detail": {},
"Mobile": "98883434559",
"Prediction_Score": null,
"First_Visited_Time": null,
"Last_Name": "Last_Name",
"Referrer": null,
"Lead_Source": "Twitter",
"Tag": [],
"Fax": "Fax"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
}请求详情:单词
| 请求 URL: | https://www.zohoapis.com/crm/v8/{module_api_name}/search?word={search_word_here} |
Attributes
- word string
使用给定的单词在指定模块内执行全局搜索。根据搜索词在多个字段中匹配记录。
示例请求按词搜索
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/search?word=abc"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"示例响应
Copied{
"data": [
{
"Owner": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Company": "Company1",
"Email": null,
"$currency_symbol": "Rs.",
"Visitor_Score": null,
"Last_Activity_Time": null,
"Industry": null,
"$converted": false,
"$process_flow": false,
"Street": null,
"Zip_Code": null,
"id": "3652397000000562046",
"$approved": true,
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"First_Visited_URL": null,
"Days_Visited": null,
"Created_Time": "2019-02-19T12:57:55+05:30",
"$editable": true,
"City": null,
"No_of_Employees": null,
"Campaigns_Lookup": null,
"State": null,
"Country": null,
"Last_Visited_Time": null,
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Annual_Revenue": null,
"Secondary_Email": null,
"Description": null,
"Number_Of_Chats": null,
"Rating": null,
"Website": null,
"Twitter": null,
"Average_Time_Spent_Minutes": null,
"Salutation": null,
"First_Name": null,
"Lead_Status": null,
"Full_Name": "abc",
"Record_Image": null,
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Skype_ID": null,
"Phone": null,
"Email_Opt_Out": false,
"Designation": null,
"Modified_Time": "2019-02-19T12:57:55+05:30",
"$converted_detail": {},
"Mobile": null,
"Prediction_Score": null,
"First_Visited_Time": null,
"Last_Name": "abc",
"Referrer": null,
"Lead_Source": null,
"Tag": [],
"Fax": null
},
{
"Owner": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Company": "abc",
"Email": null,
"$currency_symbol": "Rs.",
"Visitor_Score": null,
"Last_Activity_Time": "2019-02-19T12:06:28+05:30",
"Industry": "ERP (Enterprise Resource Planning)",
"$converted": false,
"$process_flow": false,
"Street": null,
"Zip_Code": null,
"id": "3652397000000538029",
"$approved": true,
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"First_Visited_URL": null,
"Days_Visited": null,
"Created_Time": "2019-02-14T18:19:22+05:30",
"$editable": true,
"City": "Albany",
"No_of_Employees": null,
"Campaigns_Lookup": null,
"State": null,
"Country": null,
"Last_Visited_Time": null,
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Annual_Revenue": null,
"Secondary_Email": null,
"Description": null,
"Number_Of_Chats": null,
"Rating": null,
"Website": null,
"Twitter": null,
"Average_Time_Spent_Minutes": null,
"Salutation": null,
"First_Name": "Test1",
"Lead_Status": "Contacted",
"Full_Name": "Test1 Lead1",
"Record_Image": null,
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Skype_ID": null,
"Phone": null,
"Email_Opt_Out": true,
"Designation": "Team Lead",
"Modified_Time": "2019-02-19T12:06:28+05:30",
"$converted_detail": {},
"Mobile": null,
"Prediction_Score": null,
"First_Visited_Time": null,
"Last_Name": "Lead1",
"Referrer": null,
"Lead_Source": "Advertisement",
"Tag": [],
"Fax": null
}
],
"info": {
"per_page": 200,
"count": 2,
"page": 1,
"more_records": false
}
}其他可选参数
- converted string
获取已转换记录的列表。默认值为 false。
- false - 仅获取未转换的记录
- true - 仅获取已转换的记录
- both - 获取所有记录
- approved string
获取已批准记录的列表。默认值是true。
- true - 仅获取已批准的记录
- false - 仅获取未批准的记录
- both - 获取所有记录
- page integer
获取相应页面的记录列表。默认值为1。
- per_page integer
指定每页返回多少记录。默认和最大可能值为200。
- type string
从Users模块获取特定的用户类型。请注意,此参数仅支持Users模块。
可能的值有:
- 所有Users
- 活跃Users
- 非活跃Users
- Confirm的Users
- Confirm的报告Users
- 未Confirm的Users
- Delete的Users
- 活跃Confirm的Users
- AdminUsers
- 活跃Confirm的Admin
- 当前用户
注意
- 在任意时间点,仅一个必填参数(criteria、email、phone、word)会生效。
- 如果提供了多个参数,API 将按以下顺序优先处理:
i. 标准
ii. 电子邮件
iii. 电话
四. 单词
只有请求中最高优先级的参数会被处理。
- page 和 per_page 参数帮助根据其在Zoho CRM中的位置检索记录。
- 单个 API 调用可以获取最多 200 条记录。
要检索更多记录,请调整 page 和 per_page 值。
示例:要获取400条记录,请按照以下步骤操作。
- First API 调用:page=1 & per_page=200 → 获取记录1-200
第二次 API 调用:page=2 & per_page=200 → 获取记录201-400
通过两次 API 调用,可以检索到所有400条记录。
- 搜索 API 允许您搜索和检索最多 2,000 条记录。如果搜索结果超过 2,000 条记录,API 将返回 "LIMIT_REACHED" 错误。
- 只有在合规设置中的通过 API 限制数据访问选项禁用时,才会检索包含敏感健康数据的字段值。如果启用该选项,值将为null。有关更多详细信息,请参阅HIPAA合规性。
- 当您创建或编辑记录并立即搜索它时,由于索引延迟,您可能会收到“204 NO CONTENT”错误。要在没有任何延迟的情况下获取记录,请使用查询 API。
- “in”运算符支持最多100个值。
- "full_Name"字段包含First Name和Last Name字段的连接值。
这是一个只读字段,仅在Leads、Contacts和Users模块中可用。
示例请求:使用单一标准进行搜索
Copiedcurl "https://www.zohoapis.com/crm/v8/Campaigns/search?criteria=Campaign_Name:equals:CRM&fields=Campaign_Name,Type"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"示例响应
Copied{
"data": [
{
"Type": "Trade Show",
"Campaign_Name": "CRM",
"id": "3652397000002247003"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
}访问子表单数据
要检索符合搜索条件的子表单记录,请使用相应子表单模块的API名称。有关子表单的更多详细信息,请参阅Kaizen #124 - 使用Zoho CRM API操作子表单。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Project_Details/search?criteria=Expected_Budget:greater_equal:40000"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"示例响应
Copied{
"data": [
{
"Status": "Negotiation in Process",
"$approval": {
"delegate": false,
"takeover": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2025-02-16T09:35:17-08:00",
"$currency_symbol": "$",
"$field_states": null,
"Created_Time": "2025-02-16T09:35:17-08:00",
"Parent_Id": {
"name": "Alice Brown",
"id": "5725767000005442025"
},
"$review_process": null,
"$editable": true,
"$layout_id": {
"name": "Standard",
"id": "5725767000002102024"
},
"$sharing_permission": "full_access",
"Project_Name": "CAD",
"Expected_Budget": 70000,
"$orchestration": false,
"$review": null,
"$process_flow": false,
"Layout": {
"name": "Standard",
"id": "5725767000002102024"
},
"$in_merge": false,
"Budget": null,
"id": "5725767000005478001",
"$approval_state": "approved",
"$pathfinder": false,
"$zia_visions": null,
"Project_Type": "Civil"
},
{
"Status": "Negotiation in Process",
"$approval": {
"delegate": false,
"takeover": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2024-06-05T04:28:30-07:00",
"$currency_symbol": "$",
"$field_states": null,
"Created_Time": "2024-06-05T04:28:30-07:00",
"Parent_Id": {
"name": "Patricia Patricia",
"id": "5725767000002954096"
},
"$review_process": null,
"$editable": true,
"$layout_id": {
"name": "Standard",
"id": "5725767000002102024"
},
"$sharing_permission": "full_access",
"Project_Name": "Mobile App Development for Productivity",
"Expected_Budget": 50000,
"$orchestration": false,
"$review": null,
"$process_flow": false,
"Layout": {
"name": "Standard",
"id": "5725767000002102024"
},
"$in_merge": false,
"Budget": null,
"id": "5725767000002954097",
"$approval_state": "approved",
"$pathfinder": false,
"$zia_visions": null,
"Project_Type": "Mobile App Development"
},
{
"Status": "Negotiation in Process",
"$approval": {
"delegate": false,
"takeover": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2024-02-07T02:39:18-08:00",
"$currency_symbol": "$",
"$field_states": null,
"Created_Time": "2024-02-07T02:39:18-08:00",
"Parent_Id": {
"name": "Patricia",
"id": "5725767000002105005"
},
"$review_process": null,
"$editable": true,
"$layout_id": {
"name": "Standard",
"id": "5725767000002102024"
},
"$sharing_permission": "full_access",
"Project_Name": "Mobile App Development for Productivity",
"Expected_Budget": 50000,
"$orchestration": false,
"$review": null,
"$process_flow": false,
"Layout": {
"name": "Standard",
"id": "5725767000002102024"
},
"$in_merge": false,
"Budget": null,
"id": "5725767000002105006",
"$approval_state": "approved",
"$pathfinder": false,
"$zia_visions": null,
"Project_Type": "Mobile App Development"
},
{
"Status": "Negotiation in Process",
"$approval": {
"delegate": false,
"takeover": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2024-02-06T23:05:20-08:00",
"$currency_symbol": "$",
"$field_states": null,
"Created_Time": "2024-02-06T22:52:18-08:00",
"Parent_Id": {
"name": "Patricia Boyle",
"id": "5725767000002085013"
},
"$review_process": null,
"$editable": true,
"$layout_id": {
"name": "Standard",
"id": "5725767000002102024"
},
"$sharing_permission": "full_access",
"Project_Name": "Social Media Integration Project",
"Expected_Budget": 40000,
"$orchestration": false,
"$review": null,
"$process_flow": false,
"Layout": {
"name": "Standard",
"id": "5725767000002102024"
},
"$in_merge": false,
"Budget": null,
"id": "5725767000002102887",
"$approval_state": "approved",
"$pathfinder": false,
"$zia_visions": null,
"Project_Type": "Marketing Automation"
},
{
"Status": "Proposal Submitted",
"$approval": {
"delegate": false,
"takeover": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2024-02-06T23:05:20-08:00",
"$currency_symbol": "$",
"$field_states": null,
"Created_Time": "2024-02-06T22:52:18-08:00",
"Parent_Id": {
"name": "Patricia Boyle",
"id": "5725767000002085013"
},
"$review_process": null,
"$editable": true,
"$layout_id": {
"name": "Standard",
"id": "5725767000002102024"
},
"$sharing_permission": "full_access",
"Project_Name": "Big Data Infrastructure Implementation",
"Expected_Budget": 60000,
"$orchestration": false,
"$review": null,
"$process_flow": false,
"Layout": {
"name": "Standard",
"id": "5725767000002102024"
},
"$in_merge": false,
"Budget": null,
"id": "5725767000002102886",
"$approval_state": "approved",
"$pathfinder": false,
"$zia_visions": null,
"Project_Type": "Infrastructure Upgrade"
},
{
"Status": "Negotiation in Process",
"$approval": {
"delegate": false,
"takeover": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2024-02-06T23:05:20-08:00",
"$currency_symbol": "$",
"$field_states": null,
"Created_Time": "2024-02-06T22:52:18-08:00",
"Parent_Id": {
"name": "Patricia Boyle",
"id": "5725767000002085013"
},
"$review_process": null,
"$editable": true,
"$layout_id": {
"name": "Standard",
"id": "5725767000002102024"
},
"$sharing_permission": "full_access",
"Project_Name": "Mobile App Development for Productivity",
"Expected_Budget": 50000,
"$orchestration": false,
"$review": null,
"$process_flow": false,
"Layout": {
"name": "Standard",
"id": "5725767000002102024"
},
"$in_merge": false,
"Budget": null,
"id": "5725767000002102885",
"$approval_state": "approved",
"$pathfinder": false,
"$zia_visions": null,
"Project_Type": "Mobile App Development"
},
{
"Status": "Negotiation in Process",
"$approval": {
"delegate": false,
"takeover": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2024-02-06T23:04:32-08:00",
"$currency_symbol": "$",
"$field_states": null,
"Created_Time": "2024-02-06T22:48:23-08:00",
"Parent_Id": {
"name": "Subic",
"id": "5725767000002099046"
},
"$review_process": null,
"$editable": true,
"$layout_id": {
"name": "Standard",
"id": "5725767000002102024"
},
"$sharing_permission": "full_access",
"Project_Name": "Advanced Analytics Platform",
"Expected_Budget": 40000,
"$orchestration": false,
"$review": null,
"$process_flow": false,
"Layout": {
"name": "Standard",
"id": "5725767000002102024"
},
"$in_merge": false,
"Budget": null,
"id": "5725767000002102856",
"$approval_state": "approved",
"$pathfinder": false,
"$zia_visions": null,
"Project_Type": "Data Analytics"
},
{
"Status": "Proposal Submitted",
"$approval": {
"delegate": false,
"takeover": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2024-02-06T23:03:37-08:00",
"$currency_symbol": "$",
"$field_states": null,
"Created_Time": "2024-02-06T22:53:58-08:00",
"Parent_Id": {
"name": "james",
"id": "5725767000002102893"
},
"$review_process": null,
"$editable": true,
"$layout_id": {
"name": "Standard",
"id": "5725767000002102024"
},
"$sharing_permission": "full_access",
"Project_Name": "Virtual Reality Training Program",
"Expected_Budget": 40000,
"$orchestration": false,
"$review": null,
"$process_flow": false,
"Layout": {
"name": "Standard",
"id": "5725767000002102024"
},
"$in_merge": false,
"Budget": null,
"id": "5725767000002102896",
"$approval_state": "approved",
"$pathfinder": false,
"$zia_visions": null,
"Project_Type": "Training and Development"
},
{
"Status": "Negotiation in Process",
"$approval": {
"delegate": false,
"takeover": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2024-02-06T23:03:37-08:00",
"$currency_symbol": "$",
"$field_states": null,
"Created_Time": "2024-02-06T22:53:58-08:00",
"Parent_Id": {
"name": "james",
"id": "5725767000002102893"
},
"$review_process": null,
"$editable": true,
"$layout_id": {
"name": "Standard",
"id": "5725767000002102024"
},
"$sharing_permission": "full_access",
"Project_Name": "Internet of Things (IoT) Integration",
"Expected_Budget": 40000,
"$orchestration": false,
"$review": null,
"$process_flow": false,
"Layout": {
"name": "Standard",
"id": "5725767000002102024"
},
"$in_merge": false,
"Budget": null,
"id": "5725767000002102895",
"$approval_state": "approved",
"$pathfinder": false,
"$zia_visions": null,
"Project_Type": "IoT"
},
{
"Status": "Future Plan",
"$approval": {
"delegate": false,
"takeover": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2024-02-06T23:03:37-08:00",
"$currency_symbol": "$",
"$field_states": null,
"Created_Time": "2024-02-06T22:53:58-08:00",
"Parent_Id": {
"name": "james",
"id": "5725767000002102893"
},
"$review_process": null,
"$editable": true,
"$layout_id": {
"name": "Standard",
"id": "5725767000002102024"
},
"$sharing_permission": "full_access",
"Project_Name": "Customer Relationship Management System",
"Expected_Budget": 50000,
"$orchestration": false,
"$review": null,
"$process_flow": false,
"Layout": {
"name": "Standard",
"id": "5725767000002102024"
},
"$in_merge": false,
"Budget": null,
"id": "5725767000002102894",
"$approval_state": "approved",
"$pathfinder": false,
"$zia_visions": null,
"Project_Type": "CRM Implementation"
}
],
"info": {
"per_page": 200,
"count": 10,
"sort_by": "id",
"page": 1,
"sort_order": "desc",
"more_records": false
}
}以下是一个示例请求,用于从特定父记录中检索子表单记录:
Copiedcurl "https://www.zohoapis.com/crm/v8/Project_Details/search?criteria=((Expected_Budget:greater_equal:40000)and(Parent_Id:equals:5725767000005442025))"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"示例响应
Copied{
"data": [
{
"Status": "Negotiation in Process",
"$approval": {
"delegate": false,
"takeover": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2025-02-16T09:35:17-08:00",
"$currency_symbol": "$",
"$field_states": null,
"Created_Time": "2025-02-16T09:35:17-08:00",
"Parent_Id": {
"name": "Alice Brown",
"id": "5725767000005442025"
},
"$review_process": null,
"$editable": true,
"$layout_id": {
"name": "Standard",
"id": "5725767000002102024"
},
"$sharing_permission": "full_access",
"Project_Name": "CAD",
"Expected_Budget": 70000,
"$orchestration": false,
"$review": null,
"$process_flow": false,
"Layout": {
"name": "Standard",
"id": "5725767000002102024"
},
"$in_merge": false,
"Budget": null,
"id": "5725767000005478001",
"$approval_state": "approved",
"$pathfinder": false,
"$zia_visions": null,
"Project_Type": "Civil"
}
],
"info": {
"per_page": 200,
"count": 1,
"sort_by": "id",
"page": 1,
"sort_order": "desc",
"more_records": false
}
}访问多选查找 (MxN) 数据
要检索符合您的搜索条件的多选查找 (MxN) 记录,请使用相应链接模块的 API 名称。有关 MxN 的更多详细信息,请参阅Kaizen #125 使用 Zoho CRM API 操作多选查找字段 (MxN)。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v6/EmpXSkills/search?criteria=((Secondary_Email:equals:patricia@mail.com)and(Skills:equals:Content_Marketing))"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
可能的错误
- INVALID_DATAHTTP 400
搜索值包含特殊字符或不包含至少两个字符
解决方法:在搜索值中指定至少两个字符,并且不要输入特殊字符。 - INVALID_QUERYHTTP 400
查询无效
解决方法:您的搜索查询中的操作符/字段 API 名称无效,传递的值与搜索字段的预期数据类型不匹配,搜索值中有特殊字符,或者指定的字段在搜索模块中不可用。请参阅响应中的 "details" JSON 对象以了解哪个值不正确。 - EXPECTED_PARAM_MISSINGHTTP 400
缺少必需的 paRAM
解决方案:在您的请求中指定任何必需的 paRAMeter(条件/电子邮件/电话/单词)以根据条件进行搜索。 - LIMIT_REACHEDHTTP 400
已达到最大响应迭代限制
解决方案:搜索记录 API 在一次 API 调用中仅返回 2000 条记录。 - NOT_SUPPORTEDHTTP 400
模块不支持搜索
解决方案:您指定的模块不支持搜索操作。请参考上面的可能模块部分并指定有效的模块 API 名称。 - INVALID_REQUEST_METHODHTTP 400
HTTP请求方法类型无效
解决方法:您指定了一个无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参阅上面的端点部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限读取模块详情。
解决方案:用户没有权限检索模块详情。请联系系统管理员。 - OAUTH_SCOPE_MISMATCHHTTP 401
未经授权
解决方案:客户端没有ZohoSearch.securesearch.READ范围。创建一个具有有效范围的新客户端。请参阅上面的范围部分。 - NO_PERMISSIONHTTP 403
没有读取权限
解决方案:用户没有读取记录的权限。请联系系统管理员。 - INVALID_URL_PATTERNHTTP 404
请检查尝试访问的URL是否正确
解决方案: 请求的URL不正确。请指定一个有效的请求URL。请参阅上面的请求URL部分。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方法:服务器中出现意外且未处理的异常。请联系支持团队。
示例响应
Copied{
"data": [
{
"Owner": {
"name": "Patricia Boyle",
"id": "5725767000000411001",
"email": "patricia+us@zohotest.com"
},
"Email": null,
"$currency_symbol": "$",
"$field_states": null,
"$review_process": null,
"Employees": {
"name": "Patricia Boyle",
"id": "5725767000002601471"
},
"$sharing_permission": "full_access",
"Name": "10024",
"Last_Activity_Time": null,
"Modified_By": {
"name": "Patricia Boyle",
"id": "5725767000000411001",
"email": "patricia+us@zohotest.com"
},
"$review": null,
"Unsubscribed_Mode": null,
"$converted": false,
"$process_flow": false,
"Skills": {
"name": "Content Marketing",
"id": "5725767000002167151"
},
"id": "5725767000005478017",
"Email_Opt_Out": false,
"$zia_visions": null,
"$approval": {
"delegate": false,
"takeover": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2025-02-16T10:01:13-08:00",
"Created_Time": "2025-02-16T10:01:13-08:00",
"$converted_detail": {},
"Unsubscribed_Time": null,
"$editable": true,
"Record_Status__s": "Available",
"$orchestration": false,
"$in_merge": false,
"Created_By": {
"name": "Patricia Boyle",
"id": "5725767000000411001",
"email": "patricia+us@zohotest.com"
},
"Secondary_Email": "patricia@mail.com",
"$approval_state": "approved",
"$pathfinder": false
}
],
"info": {
"per_page": 200,
"count": 1,
"sort_by": "id",
"page": 1,
"sort_order": "desc",
"more_records": false
}
}