Search Records API
Purpose
To retrieve the records that match your search criteria.
Request Details
Request URL
https://www.zohoapis.com/bigin/v1/search
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoBigin.modules.{module_name}.{operation_type}
(and)
scope=ZohoSearch.securesearch.READ
Possible module names
accounts, contacts, deals, tasks, events, calls, products, notes, and activities
Possible operation types
ALL - Full access to the record
READ - Get records from the module
Request Details: criteria
Request URL: | https://www.zohoapis.com/bigin/v1/{module_api_name}/search?criteria={{criteria_here}} |
Attributes
- criteriastring
Performs search by following the shown criteria. (({api_name}:{starts_with|equals}:{value})and/or({api_name}:{starts_with|equals}:{value}))
You can search for a maximum of 10 criteria (with same or different columns) with equals and starts_with conditions.
When you use parentheses or comma in the value for a criteria, you must escape them using a backslash. Further, you must encode the value.
Example:
Consider the search term: ((Last_Name:equals:Burns,B)and(First_Name:starts_with:M))
After escaping comma and parenthesis in the value: ((Last_Name:equals:Burns\,B)and(First_Name:starts_with:M))
After encoding the value: ((Last_Name:equals:Burns%5C%2CB)and(First_Name:starts_with:M))To search for Date, DateTime, Lookup, Number, Currency, Boolean fields, you need comparators other than starts_with and equals.
Sample Request to Search with criteria
Copiedcurl "https://www.zohoapis.com/bigin/v1/Contacts/search?criteria=((Last_Name:equals:Burns%5C%2CB)and(First_Name:starts_with:M))"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedZCRMModule moduleIns=ZCRMRestClient.getInstance().getModuleInstance("Leads");//To get module instance,"Leads" is the module api name
String Criteria="((Last_Name:starts_with:B)and(First_Name:equals:Mary)";//criteria to search with
int page=1;//page number
int perpage=200;//records per page
BulkAPIResponse response=moduleIns.searchByCriteria(Criteria,page,perpage);//to get the record ,if any parameter(except Criteria) is not needed set null
List<ZCRMRecord> records=(List <ZCRMRecord> )response.getData();
Copied$moduleIns=ZCRMRestClient::getInstance()->getModuleInstance("Leads"); //To get module instance
$response=$moduleIns->searchRecordsByCriteria("("((Last_Name:starts_with:B) and (Email:equals:burns.mary@xyz.com))")",1,200); //To get module records that match the criteria
$records=$response->getData(); //To get response data
Copieddef search_records_by_criteria(self):
try:
module_ins = zcrmsdk.ZCRMModule.get_instance('Invoices')
resp = module_ins.search_records_by_criteria('((Owner:equals:554023000000235011)or(Invoice_Number:equals:554023000000464007))')
print(resp.status_code)
resp_info = resp.info
print(resp_info.count)
print(resp_info.page)
print(resp_info.per_page)
print(resp_info.is_more_records)
record_ins_arr = resp.data
for record_ins in record_ins_arr:
print(record_ins.entity_id)
print(record_ins.created_by.id)
print(record_ins.modified_by.id)
print(record_ins.owner.id)
print(record_ins.created_by.name)
print(record_ins.created_time)
print(record_ins.modified_time)
print(record_ins.get_field_value('Email')) # To get particular field value
if record_ins.line_items is not None:
for line_item in record_ins.line_items:
print("::::::LINE ITEM DETAILS::::::")
print(line_item.id)
print(line_item.product.lookup_label)
print(line_item.product.get_field_value('Product_Code'))
print(line_item.product.entity_id)
print(line_item.list_price)
print(line_item.quantity)
print(line_item.description)
print(line_item.total)
print(line_item.discount)
print(line_item.discount_percentage)
print(line_item.total_after_discount)
print(line_item.tax_amount)
print(line_item.net_total)
print(line_item.delete_flag)
if line_item.line_tax is not None:
for tax in line_item.line_tax:
print(":::::: TAX DETAILS ::::::")
print(tax.name)
print(tax.value)
print(tax.percentage)
field_data = record_ins.field_data
for key in field_data:
print(key + ":" + str(field_data[key]))
print("\n\n")
except zcrmsdk.ZCRMException as ex:
print(ex.status_code)
print(ex.error_message)
print(ex.error_code)
print(ex.error_details)
print(ex.error_content)
CopiedSyntax:
zoho.crm.searchRecords(<module String>,<criteria String>,<page Long>,<perPage Long>,<connectionName String>,<userAccess Boolean>);
mandatory : module,criteria
Sample Request:
resp = zoho.crm.searchRecords("Leads", "((Last_Name:equals:Hawkins) or (Last_Name:starts_with:Pat))");
CopiedZCRMModule module = ZCRMModule.GetInstance("Leads");
BulkAPIResponse<ZCRMRecord> response = module.SearchByCriteria("((Last_Name:starts_with:B) or (Email:equals:burns.mary@xyz.com))");
List<ZCRMRecord> records = response.BulkData; //To get response List of ZCRMRecord.
Sample Response
Copied{
"data": [
{
"Owner": {
"name": "Patricia Boyle",
"id": "1003680000000338001",
"email": "pboyle@zylker.com"
},
"Email": "mburns@zylker.com",
"Description": "developer",
"$currency_symbol": "$",
"Mailing_Zip": "600016",
"Mailing_State": "California",
"currencyval": null,
"Mailing_Street": "1129, Virginia",
"$followers": null,
"salary": null,
"Last_Activity_Time": "2020-11-23T18:43:52+05:30",
"First_Name": "Mary",
"Full_Name": "Mary Burns",
"Record_Image": null,
"Modified_By": {
"name": "Patricia Boyle",
"id": "1003680000000338001",
"email": "pboyle@zylker.com"
},
"bday": null,
"Phone": null,
"Mailing_Country": "USA",
"Account_Name": {
"name": "Watson's Professional Services",
"id": "1003680000000341352"
},
"fav_colour": [],
"id": "1003680000000364004",
"Email_Opt_Out": false,
"Modified_Time": "2020-11-23T18:43:52+05:30",
"Mailing_City": "Virginia",
"test": null,
"Created_Time": "2020-09-19T23:15:38+05:30",
"Travel_Flexibility": false,
"$followed": false,
"Title": "developer",
"$editable": true,
"Mobile": "88282348384",
"Home_Phone": null,
"gggg": null,
"Last_Name": "Burns,B",
"shsfhshdf": null,
"Tag": [
{
"name": "sampletag",
"id": "1003680000000574077"
}
],
"Created_By": {
"name": "Patricia Boyle",
"id": "1003680000000338001",
"email": "pboyle@zylker.com"
},
"$approval_state": "approved"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
}
CopiedZCRMModule moduleIns=ZCRMRestClient.getInstance().getModuleInstance("Leads");//To get module instance,"Leads" is the module api name
String Criteria="((Last_Name:starts_with:B)and(First_Name:equals:Mary)";//criteria to search with
int page=1;//page number
int perpage=200;//records per page
BulkAPIResponse response=moduleIns.searchByCriteria(Criteria,page,perpage);//to get the record ,if any parameter(except Criteria) is not needed set null
List<ZCRMRecord> records=(List <ZCRMRecord> )response.getData();
Copied$moduleIns=ZCRMRestClient::getInstance()->getModuleInstance("Leads"); //To get module instance
$response=$moduleIns->searchRecordsByCriteria("("((Last_Name:starts_with:B) and (Email:equals:burns.mary@xyz.com))")",1,200); //To get module records that match the criteria
$records=$response->getData(); //To get response data
Copieddef search_records_by_criteria(self):
try:
module_ins = zcrmsdk.ZCRMModule.get_instance('Invoices')
resp = module_ins.search_records_by_criteria('((Owner:equals:554023000000235011)or(Invoice_Number:equals:554023000000464007))')
print(resp.status_code)
resp_info = resp.info
print(resp_info.count)
print(resp_info.page)
print(resp_info.per_page)
print(resp_info.is_more_records)
record_ins_arr = resp.data
for record_ins in record_ins_arr:
print(record_ins.entity_id)
print(record_ins.created_by.id)
print(record_ins.modified_by.id)
print(record_ins.owner.id)
print(record_ins.created_by.name)
print(record_ins.created_time)
print(record_ins.modified_time)
print(record_ins.get_field_value('Email')) # To get particular field value
if record_ins.line_items is not None:
for line_item in record_ins.line_items:
print("::::::LINE ITEM DETAILS::::::")
print(line_item.id)
print(line_item.product.lookup_label)
print(line_item.product.get_field_value('Product_Code'))
print(line_item.product.entity_id)
print(line_item.list_price)
print(line_item.quantity)
print(line_item.description)
print(line_item.total)
print(line_item.discount)
print(line_item.discount_percentage)
print(line_item.total_after_discount)
print(line_item.tax_amount)
print(line_item.net_total)
print(line_item.delete_flag)
if line_item.line_tax is not None:
for tax in line_item.line_tax:
print(":::::: TAX DETAILS ::::::")
print(tax.name)
print(tax.value)
print(tax.percentage)
field_data = record_ins.field_data
for key in field_data:
print(key + ":" + str(field_data[key]))
print("\n\n")
except zcrmsdk.ZCRMException as ex:
print(ex.status_code)
print(ex.error_message)
print(ex.error_code)
print(ex.error_details)
print(ex.error_content)
CopiedSyntax:
zoho.crm.searchRecords(<module String>,<criteria String>,<page Long>,<perPage Long>,<connectionName String>,<userAccess Boolean>);
mandatory : module,criteria
Sample Request:
resp = zoho.crm.searchRecords("Leads", "((Last_Name:equals:Hawkins) or (Last_Name:starts_with:Pat))");
CopiedZCRMModule module = ZCRMModule.GetInstance("Leads");
BulkAPIResponse<ZCRMRecord> response = module.SearchByCriteria("((Last_Name:starts_with:B) or (Email:equals:burns.mary@xyz.com))");
List<ZCRMRecord> records = response.BulkData; //To get response List of ZCRMRecord.
Request Details: email
Request URL: | https://www.zohoapis.com/bigin/v1/{module_api_name}/search?email={{email_here}} |
Attributes
- emailstring
Performs module search by email. All the email fields of a particular module will be searched and listed.
Sample Request to Search by email
Copiedcurl "https://www.zohoapis.com/bigin/v1/Contacts/search?email=newcrmapi@zoho.com"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedZCRMModule moduleIns=ZCRMRestClient.getInstance().getModuleInstance("Leads");//To get module instance,"Leads" is the module api name
String Email="newcrmapi@zoho.com";//email to search with
int page=1;//page number
int perpage=200;//records per page
BulkAPIResponse response=moduleIns.searchByEmail(Email,page,perpage);//to get the record ,if any parameter(except email) is not needed set null
List<ZCRMRecord> records=(List <ZCRMRecord> )response.getData();
Copied$moduleIns=ZCRMRestClient::getInstance()->getModuleInstance("Leads"); //To get module instance
$response=$moduleIns->searchRecordsByEmail("newcrmapi@zoho.com",1,200); //To get module records that match the Email address
$records=$response->getData(); //To get response data
Copieddef search_records_by_email(self):
try:
module_ins = zcrmsdk.ZCRMModule.get_instance('Contacts')
resp = module_ins.search_records_by_email('steve@xyz.com')
print(resp.status_code)
resp_info = resp.info
print(resp_info.count)
print(resp_info.page)
print(resp_info.per_page)
print(resp_info.is_more_records)
record_ins_arr = resp.data
for record_ins in record_ins_arr:
print(record_ins.entity_id)
print(record_ins.created_by.id)
print(record_ins.modified_by.id)
print(record_ins.owner.id)
print(record_ins.created_by.name)
print(record_ins.created_time)
print(record_ins.modified_time)
print(record_ins.get_field_value('Email')) # To get particular field value
field_data = record_ins.field_data
for key in field_data:
print(key + ":" + str(field_data[key]))
print("\n\n")
except zcrmsdk.ZCRMException as ex:
print(ex.status_code)
print(ex.error_message)
print(ex.error_code)
print(ex.error_details)
print(ex.error_content)
CopiedZCRMModule module = ZCRMModule.GetInstance("Leads");
BulkAPIResponse<ZCRMRecord> response = module.SearchByEmail("newcrmapi@zoho.com");
List<ZCRMRecord> records = response.BulkData; //To get response List of ZCRMRecord
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2/Leads/search?email=newcrmapi@zoho.com"
type: GET
connection:"crm_oauth_connection"
];
info response;
Sample Response
Copied{
"data": [
{
"Account": null,
"Owner": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Company": null,
"Email": "newcrmapi@zoho.com",
"$currency_symbol": "Rs.",
"Last_Activity_Time": "2019-03-22T11:10:55+05:30",
"Mailing_Street": "Street",
"Mailing_Zip": "Zip_Code",
"id": "3652397000000415002",
"$approved": true,
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Created_Time": "2019-01-10T13:04:32+05:30",
"$editable": true,
"Mailing_City": "City",
"Mailing_State": "State",
"Mailing_Country": "Country",
"Last_Visited_Time": null,
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Email": "newcrmapi@zoho.com",
"Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
"Salutation": "Mr.",
"First_Name": "First_Name",
"Full_Name": "Mr. First_Name Last_Name",
"Record_Image": null,
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Phone": "98883434559",
"Email_Opt_Out": false,
"Modified_Time": "2019-03-22T11:10:55+05:30",
"Mobile": "98883434559",
"Last_Name": "Last_Name",
"Tag": []
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
}
CopiedZCRMModule moduleIns=ZCRMRestClient.getInstance().getModuleInstance("Leads");//To get module instance,"Leads" is the module api name
String Email="newcrmapi@zoho.com";//email to search with
int page=1;//page number
int perpage=200;//records per page
BulkAPIResponse response=moduleIns.searchByEmail(Email,page,perpage);//to get the record ,if any parameter(except email) is not needed set null
List<ZCRMRecord> records=(List <ZCRMRecord> )response.getData();
Copied$moduleIns=ZCRMRestClient::getInstance()->getModuleInstance("Leads"); //To get module instance
$response=$moduleIns->searchRecordsByEmail("newcrmapi@zoho.com",1,200); //To get module records that match the Email address
$records=$response->getData(); //To get response data
Copieddef search_records_by_email(self):
try:
module_ins = zcrmsdk.ZCRMModule.get_instance('Contacts')
resp = module_ins.search_records_by_email('steve@xyz.com')
print(resp.status_code)
resp_info = resp.info
print(resp_info.count)
print(resp_info.page)
print(resp_info.per_page)
print(resp_info.is_more_records)
record_ins_arr = resp.data
for record_ins in record_ins_arr:
print(record_ins.entity_id)
print(record_ins.created_by.id)
print(record_ins.modified_by.id)
print(record_ins.owner.id)
print(record_ins.created_by.name)
print(record_ins.created_time)
print(record_ins.modified_time)
print(record_ins.get_field_value('Email')) # To get particular field value
field_data = record_ins.field_data
for key in field_data:
print(key + ":" + str(field_data[key]))
print("\n\n")
except zcrmsdk.ZCRMException as ex:
print(ex.status_code)
print(ex.error_message)
print(ex.error_code)
print(ex.error_details)
print(ex.error_content)
CopiedZCRMModule module = ZCRMModule.GetInstance("Leads");
BulkAPIResponse<ZCRMRecord> response = module.SearchByEmail("newcrmapi@zoho.com");
List<ZCRMRecord> records = response.BulkData; //To get response List of ZCRMRecord
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2/Leads/search?email=newcrmapi@zoho.com"
type: GET
connection:"crm_oauth_connection"
];
info response;
Request Details: phone
Request URL: | https://www.zohoapis.com/bigin/v1/{module_api_name}/search?phone={{phone_number_here}} |
Attributes
- phonestring
Performs module search by phone number. All the phone fields of a particular module will be searched and listed.
Sample Request to Search by Phone
Copiedcurl "https://www.zohoapis.com/bigin/v1/Contacts/search?phone=98883434559
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedZCRMModule moduleIns=ZCRMRestClient.getInstance().getModuleInstance("Leads");//To get module instance,"Leads" is the module api name
String phone="98883434559";//phone to search with
int page=1;//page number
int perpage=200;//records per page
BulkAPIResponse response=moduleIns.searchByPhone(phone,page,perpage);//to get the record ,if any parameter(except phone) is not needed set null
List<ZCRMRecord> records=(List <ZCRMRecord> )response.getData();
Copied$moduleIns=ZCRMRestClient::getInstance()->getModuleInstance("Leads"); //To get module instance
$response=$moduleIns->searchRecordsByPhone(98883434559,1,200); //To get module records that match the phone number
$records=$response->getData(); //To get response data
Copieddef search_records_by_phone(self):
try:
module_ins = zcrmsdk.ZCRMModule.get_instance('Leads')
resp = module_ins.search_records_by_phone('98883434559')
print(resp.status_code)
resp_info = resp.info
print(resp_info.count)
print(resp_info.page)
print(resp_info.per_page)
print(resp_info.is_more_records)
record_ins_arr = resp.data
for record_ins in record_ins_arr:
print(record_ins.entity_id)
print(record_ins.created_by.id)
print(record_ins.modified_by.id)
print(record_ins.owner.id)
print(record_ins.created_by.name)
print(record_ins.created_time)
print(record_ins.modified_time)
print(record_ins.get_field_value('Email')) # To get particular field value
field_data = record_ins.field_data
for key in field_data:
print(key + ":" + str(field_data[key]))
print("\n\n")
except zcrmsdk.ZCRMException as ex:
print(ex.status_code)
print(ex.error_message)
print(ex.error_code)
print(ex.error_details)
print(ex.error_content)
CopiedZCRMModule module = ZCRMModule.GetInstance("Leads");
BulkAPIResponse<ZCRMRecord> response = module.SearchByPhone("98883434559");
List<ZCRMRecord> records = response.BulkData; //To get response List of ZCRMRecord.
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2/Leads/search?phone=98883434559"
type: GET
connection:"crm_oauth_connection"
];
info response;
Sample Response
Copied{
"data": [
{
"Account": null,
"Owner": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Company": null,
"Email": "newcrmapi@zoho.com",
"Last_Activity_Time": "2019-03-22T11:10:55+05:30",
"Mailing_Street": "Street",
"Mailing_Zip": "Zip_Code",
"id": "3652397000000415002",
"$approved": true,
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Created_Time": "2019-01-10T13:04:32+05:30",
"$editable": true,
"Mailing_City": "City",
"Mailing_State": "State",
"Mailing_Country": "Country",
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Email": "newcrmapi@zoho.com",
"Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
"Salutation": "Mr.",
"First_Name": "First_Name",
"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,
"Modified_Time": "2019-03-22T11:10:55+05:30",
"Mobile": "98883434559",
"Last_Name": "Last_Name",
"Tag": [],
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
}
CopiedZCRMModule moduleIns=ZCRMRestClient.getInstance().getModuleInstance("Leads");//To get module instance,"Leads" is the module api name
String phone="98883434559";//phone to search with
int page=1;//page number
int perpage=200;//records per page
BulkAPIResponse response=moduleIns.searchByPhone(phone,page,perpage);//to get the record ,if any parameter(except phone) is not needed set null
List<ZCRMRecord> records=(List <ZCRMRecord> )response.getData();
Copied$moduleIns=ZCRMRestClient::getInstance()->getModuleInstance("Leads"); //To get module instance
$response=$moduleIns->searchRecordsByPhone(98883434559,1,200); //To get module records that match the phone number
$records=$response->getData(); //To get response data
Copieddef search_records_by_phone(self):
try:
module_ins = zcrmsdk.ZCRMModule.get_instance('Leads')
resp = module_ins.search_records_by_phone('98883434559')
print(resp.status_code)
resp_info = resp.info
print(resp_info.count)
print(resp_info.page)
print(resp_info.per_page)
print(resp_info.is_more_records)
record_ins_arr = resp.data
for record_ins in record_ins_arr:
print(record_ins.entity_id)
print(record_ins.created_by.id)
print(record_ins.modified_by.id)
print(record_ins.owner.id)
print(record_ins.created_by.name)
print(record_ins.created_time)
print(record_ins.modified_time)
print(record_ins.get_field_value('Email')) # To get particular field value
field_data = record_ins.field_data
for key in field_data:
print(key + ":" + str(field_data[key]))
print("\n\n")
except zcrmsdk.ZCRMException as ex:
print(ex.status_code)
print(ex.error_message)
print(ex.error_code)
print(ex.error_details)
print(ex.error_content)
CopiedZCRMModule module = ZCRMModule.GetInstance("Leads");
BulkAPIResponse<ZCRMRecord> response = module.SearchByPhone("98883434559");
List<ZCRMRecord> records = response.BulkData; //To get response List of ZCRMRecord.
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2/Leads/search?phone=98883434559"
type: GET
connection:"crm_oauth_connection"
];
info response;
Request Details: word
Request URL: | https://www.zohoapis.com/bigin/v1/{module_api_name}/search?word={{search_word_here}} |
Attributes
- wordstring
Performs global search by word.
Sample Request to Search by word
Copiedcurl "https://www.zohoapis.com/bigin/v1/Contacts/search?word=abc"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedZCRMModule moduleIns=ZCRMRestClient.getInstance().getModuleInstance("Leads");//To get module instance,"Leads" is the module api name
String searchtext="abc";//text to search with
int page=1;//page number
int perpage=50;//records per page
BulkAPIResponse response=moduleIns.searchByText(searchtext,page,perpage);//to get the record ,if any parameter(except text) is not needed set null
List<ZCRMRecord> records=(List <ZCRMRecord> )response.getData();
Copied$moduleIns=ZCRMRestClient::getInstance()->getModuleInstance("Leads"); //To get module instance
$response=$moduleIns->searchRecords(abc,1,200); //To get module records that match the search word
$records=$response->getData(); //To get response data
Copieddef search_records(self):
try:
module_ins = zcrmsdk.ZCRMModule.get_instance('Quotes')
resp = module_ins.search_records('(Sub)')
print(resp.status_code)
resp_info = resp.info
print(resp_info.count)
print(resp_info.page)
print(resp_info.per_page)
print(resp_info.is_more_records)
record_ins_arr = resp.data
for record_ins in record_ins_arr:
print(record_ins.entity_id)
print(record_ins.created_by.id)
print(record_ins.modified_by.id)
print(record_ins.owner.id)
print(record_ins.created_by.name)
print(record_ins.created_time)
print(record_ins.modified_time)
print(record_ins.get_field_value('Email')) # To get particular field value
if record_ins.line_items is not None:
for line_item in record_ins.line_items:
print("::::::LINE ITEM DETAILS::::::")
print(line_item.id)
print(line_item.product.lookup_label)
print(line_item.product.get_field_value('Product_Code'))
print(line_item.product.entity_id)
print(line_item.list_price)
print(line_item.quantity)
print(line_item.description)
print(line_item.total)
print(line_item.discount)
print(line_item.discount_percentage)
print(line_item.total_after_discount)
print(line_item.tax_amount)
print(line_item.net_total)
print(line_item.delete_flag)
if line_item.line_tax is not None:
for tax in line_item.line_tax:
print(":::::: TAX DETAILS ::::::")
print(tax.name)
print(tax.value)
print(tax.percentage)
field_data = record_ins.field_data
for key in field_data:
print(key + ":" + str(field_data[key]))
print("\n\n")
except ZCRMException as ex:
print ex.status_code
print ex.error_message
print ex.error_code
print ex.error_details
print ex.error_content
CopiedZCRMModule module = ZCRMModule.GetInstance("Leads");
BulkAPIResponse<ZCRMRecord> response = module.SearchByWord("abc");/** key value */
List<ZCRMRecord> records = response.BulkData; //To get response List of ZCRMRecord.
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2/Leads/search?word=abc"
type: GET
connection:"crm_oauth_connection"
];
info response;
Sample Response
Copied{
"data": [
{
"Owner": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Company": "Company1",
"Email": null,
"Last_Activity_Time": null,
"Mailing_Street": null,
"Mailing_Zip": null,
"id": "3652397000000562046",
"$approved": true,
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Created_Time": "2019-02-19T12:57:55+05:30",
"$editable": true,
"Mailing_City": null,
"Mailing_State": null,
"Mailing_Country": null,
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Description": 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,
"Modified_Time": "2019-02-19T12:57:55+05:30",
"Mobile": null,
"First_Visited_Time": null,
"Last_Name": "abc",
"Tag": [],
"Fax": null
},
{
"Owner": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Company": "abc",
"Email": 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
},
"Created_Time": "2019-02-14T18:19:22+05:30",
"$editable": true,
"Mailing_City": "Albany",
"Mailing_State": null,
"Mailing_Country": null,
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Description": null,
"Salutation": null,
"First_Name": "Test1",
"Lead_Status": "Contacted",
"Full_Name": "Test1 Contact1",
"Record_Image": null,
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Phone": null,
"Email_Opt_Out": true,
"Modified_Time": "2019-02-19T12:06:28+05:30",
"Mobile": null,
"Last_Name": "Contact1",
"Tag": []
}
],
"info": {
"per_page": 200,
"count": 2,
"page": 1,
"more_records": false
}
}
CopiedZCRMModule moduleIns=ZCRMRestClient.getInstance().getModuleInstance("Leads");//To get module instance,"Leads" is the module api name
String searchtext="abc";//text to search with
int page=1;//page number
int perpage=50;//records per page
BulkAPIResponse response=moduleIns.searchByText(searchtext,page,perpage);//to get the record ,if any parameter(except text) is not needed set null
List<ZCRMRecord> records=(List <ZCRMRecord> )response.getData();
Copied$moduleIns=ZCRMRestClient::getInstance()->getModuleInstance("Leads"); //To get module instance
$response=$moduleIns->searchRecords(abc,1,200); //To get module records that match the search word
$records=$response->getData(); //To get response data
Copieddef search_records(self):
try:
module_ins = zcrmsdk.ZCRMModule.get_instance('Quotes')
resp = module_ins.search_records('(Sub)')
print(resp.status_code)
resp_info = resp.info
print(resp_info.count)
print(resp_info.page)
print(resp_info.per_page)
print(resp_info.is_more_records)
record_ins_arr = resp.data
for record_ins in record_ins_arr:
print(record_ins.entity_id)
print(record_ins.created_by.id)
print(record_ins.modified_by.id)
print(record_ins.owner.id)
print(record_ins.created_by.name)
print(record_ins.created_time)
print(record_ins.modified_time)
print(record_ins.get_field_value('Email')) # To get particular field value
if record_ins.line_items is not None:
for line_item in record_ins.line_items:
print("::::::LINE ITEM DETAILS::::::")
print(line_item.id)
print(line_item.product.lookup_label)
print(line_item.product.get_field_value('Product_Code'))
print(line_item.product.entity_id)
print(line_item.list_price)
print(line_item.quantity)
print(line_item.description)
print(line_item.total)
print(line_item.discount)
print(line_item.discount_percentage)
print(line_item.total_after_discount)
print(line_item.tax_amount)
print(line_item.net_total)
print(line_item.delete_flag)
if line_item.line_tax is not None:
for tax in line_item.line_tax:
print(":::::: TAX DETAILS ::::::")
print(tax.name)
print(tax.value)
print(tax.percentage)
field_data = record_ins.field_data
for key in field_data:
print(key + ":" + str(field_data[key]))
print("\n\n")
except ZCRMException as ex:
print ex.status_code
print ex.error_message
print ex.error_code
print ex.error_details
print ex.error_content
CopiedZCRMModule module = ZCRMModule.GetInstance("Leads");
BulkAPIResponse<ZCRMRecord> response = module.SearchByWord("abc");/** key value */
List<ZCRMRecord> records = response.BulkData; //To get response List of ZCRMRecord.
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2/Leads/search?word=abc"
type: GET
connection:"crm_oauth_connection"
];
info response;