Zoho V2 Rest API Search Criteria

Question

As Zoho is going to deprecate the v1 support for rest API. I am changing the API's to support v2.

Earlier there was a field in Lead module saying lastModifiedTime which helped to get only those leads which are modified. And the query string contained lastModifiedTime={SOMEDATETIME}.

But in the new version of API, I am not able to apply that criteria. Below is my URL.

https://www.zohoapis.com/crm/v2/Leads/search?criteria=(Modified Time:equals:2018-07-19T17:39:46+05:30)

I tried different fields but all the date fields are giving me the below error.

{ "code": "INVALID_QUERY", "details": { "reason": "the field is not available for search", "api_name": "Modified Time" }, "message": "invalid query formed", "status": "error" }

score 5 · Answer 1 · answered Sep 13 '18 at 15:58

5

It returns this error when you enter a non-existent API field name (or a hidden or inactive field). I was having the same problem, then I discovered that the API field name was spelled wrong (I was spelling it right, but it was spelled wrong in the database). Anyway, in your case it's probably just that you're missing the underscore; your API field name should probably be Modified_Time, as spaces are not allowed in API field names.

answered Sep 13 '18 at 15:58

Clark

51
2

Ok, I will try that, besides do you know is there any way we can get records greater than a modified_time. – Furquan Khan Oct 05 '18 at 11:06

score 5 · Answer 2 · answered Sep 25 '18 at 13:00

5

I think it is because you use space between words. Try to use _ between words in criteria

https://www.zohoapis.com/crm/v2/Leads/search?criteria=(Modified_Time:equals:2018-07-19T17:39:46+05:30)

answered Sep 25 '18 at 13:00

Eugene

61
1
4

Would you happen to know how to search a custom module? – sunknudsen Jul 30 '20 at 17:58

score 3 · Answer 3 · answered Feb 08 '20 at 11:12

Both answers are accurate. Check the Field Names under CRM -> Setup -> Developer Space -> API -> Field Names to make sure you use '_' and no spaces.

Also, if you are using compound search criteria, wrap everything in a (), so...

((Account_Name:equals:Acme Plumbing)and(Billing_City:starts_with:Denver))

failure to wrap everything in () will also spit out the same error

score 0 · Answer 4 · edited Feb 04 '22 at 03:28

0

I am using search Criteria in Postman using ZohoCreator Search API.
It's working fine on my postman passing the params variable.

Here is the postman image showing how to pass the value:

edited Feb 04 '22 at 03:28

Joundill

6,828
12
36
50

answered Feb 01 '22 at 07:50

shobhnath

1
4

score 0 · Answer 5 · answered Feb 15 '23 at 19:06

The trick to finding the answer here is, unsurprisingly, reading the error message:

... "reason": "the field is not available for search",...

Quoting from the documentation:

To search for Date, DateTime, Lookup, Number, Currency, Boolean fields, you need comparators other than starts_with and equals. Refer to the Query API to search for fields of these data types.

You can only use the search records API for certain datatypes. You're searching for a datetime data type, which is not supported with the search records API. As the documentation says, you have to use the Query API for this (unfortunately. I'm in the same boat as you).

Zoho V2 Rest API Search Criteria

5 Answers5