Search Records

Purpose

To search records using field values.

Request URL

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

Request Method

GET

Scope

scope=ZohoFSM.modules.<module_name>.READ

Parameters

Parameter Name	Data Type	Description	Mandatory
api_name	String	API name of field to be searched on	Yes
value	String	Field value	Yes
page (optional)	Integer	To get the list of records from the respective pages. Default value for page is 1.
per_page (optional)	Integer	To get the list of records available per page. Default value for page is 200.

Supported Modules and Fields

Module Name	Field Name
Contacts	Email, Last_Name, ZBilling_Id
Companies	Company_Name, ZBilling_Id
Service_And_Parts	Name, ZBilling_Id
Assets	Name

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"
   }