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. | |
| 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 |
| Companies | Companies | Company_Name, ZBilling_Id, ZCRM_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 |
| 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/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).
§ Goods and Service are the acceptable values.
Sample Request
Copied
Sample Success Response
Copied
Sample Failure Response
Copied
Sample Failure Response
Copied
Sample Failure Response
Copied