Search Records

Purpose

To search records using field values.

Request URL

https://fsm.zoho.com/fsm/v1/<module_api_name>/search

module_api_name - The API name of the module whose record you want to search

Request Method

GET

Scope

scope=ZohoFSM.modules.<module_name>.READ

Parameters

Name	Data Type	Description	Mandatory
api_name	String	API name of field to be searched on	Yes
value	String	Field value with which to perform the search	Yes
comparator	String	Use this parameter to determine how the search should be performed. The values allowed are: contains: will fetch records whose field value or a substring of the field value matches the search string equal: will fetch records whose field value exactly matches the search string Unless specified the contains operator will be considered. If your search string contains a comma, you must escape it using a backslash and then encode it. When searching with DateTime values, the values allowed are: equal: will fetch records whose DateTime field equals the specified value not_equal: will fetch records whose DateTime field does not equal the specified value greater_than: will fetch records whose DateTime field is after the specified value greater_equal: will fetch records whose DateTime field is on or after the specified value less_than: will fetch records whose DateTime field is before the specified value less_equal: will fetch records whose DateTime field is on or before the specified value between: will fetch records whose DateTime field falls within the specified range (requires comma-separated values) not_between: will fetch records whose DateTime field falls outside the specified range (requires comma-separated values)
page	Integer	To get the list of records from the respective pages. Default value for page is 1.
per_page	Integer	To get the list of records available per page. Default value for page is 200.

Supported Modules and Fields

Module Name	Module API Name	Field API Name
Contacts	Contacts	Email, Last_Name, Mobile, Phone, ZBilling_Id, ZCRM_Id, ZDesk_Id^§
Companies	Companies	Company_Name, ZBilling_Id, ZCRM_Id, ZDesk_Id^§
Requests	Requests	Company, Contact, Name, Status, Territory, ZCRM_Deals_Id, ZCRM_Deals_Name, ZDesk_Ticket_Id^⫳
Estimates	Estimates	Company, Contact, Name, Status, Territory, ZCRM_Deals_Id, ZCRM_Deals_Name, ZDesk_Ticket_Id^⫳
WorkOrders	Work_Orders	Company, Contact, Name, Status^‡, Territory, ZCRM_Deals_Id, ZCRM_Deals_Name, ZDesk_Ticket_Id^⫳
ServiceAppointments	Service_Appointments	Company, Contact, Name, Status, Territory, Scheduled_Start_Date_Time⇞
Service_And_Parts	Service_And_Parts	Name, ZBilling_Id, ZCRM_Id, Type^§
Assets	Assets	Name, Asset_Number
Territories	Territories	Name, City, State, Country, Zip_Code
Skills	Skills	Name

§This is the ID of the Zoho Desk Account/Contact from which the Zoho FSM company/contact was created.

*This is the ID/Name of the Zoho CRM Deal from which the Zoho FSM record was created.

⫳This is the ID of the Zoho Desk Ticket from which the Zoho FSM record was created.

‡ If you search by the Completed status, then the records fetched will be in descending order of completed time (recently completed ones first).

⇞The value must be in the ISO format: YYYY-MM-DDThh:mm:ssTZD. Encode as required. Refer to the Parameters table for the acceptable value for the comparator.

§ Goods and Service are the acceptable values.

Sample Request

Copiedcurl --request GET 'https://fsm.zoho.com/fsm/v1/Companies/search?api_name=Company_Name&value=test' \
--header 'Authorization: Zoho-oauthtoken 1000.xxxx.xxxxxe'

Sample Success Response

Copied{
   "data": [
       {
           "Owner": {
               "name": "Harry",
               "id": "111112000000032788",
               "email": "harry@zohotest.com"
           },
           "Phone": "12",
           "Company_Type": "Analyst",
           "Website": "www.zoho.com",
           "Company_Name": "Test Company",
           "id": "111112000000038009"
       }
   ],
   "info": {
       "per_page": 200,
       "count": 1,
       "page": 1,
       "more_records": false
   }
}

Sample Failure Response

Copied{
       "code": "INVALID_DATA",
       "details": {
           "supported_values": [
               "Name"
           ]
       },
       "message": "Unsupported field for search",
       "status": "error"
   }

Sample Failure Response

Copied{
       "code": "INVALID_DATA",
       "details": {},
       "message": "Invalid module specified for search",
       "status": "error"
   }

Sample Failure Response

Copied{
       "code": "INVALID_REQUEST",
       "details": {},
       "message": "unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.",
       "status": "error"
   }