Happy Business Starts Here

Tutor

ZOQL support over REST API?

Hi Community, 


Does ZOQL is supported over REST api similar to SOAP Api? 

AQUA Apis are there to run batch query but can we perform "query" like operation over REST APIs? 

 

If yes, please share any knowledge link. 

 

Thanks,
Sagar. 

1 REPLY 1
Master

Re: ZOQL support over REST API?

Hi @sapatel!

 

Yes, ZOQL is also supported in REST API. It can be executed like SOAP's query method.

 

Information on the REST API is summarized in the Developer Center. The Developer Center's API Reference is the main instructions. The "Query" section in this will be useful for you.

 

If you are going to try the REST API, a tool called "Postman" is recommended. If you have never used Postman, you should watch the following wonderful video:

https://community.zuora.com/t5/SME-Sessions/Best-Practice-API-How-to-Use-Postman/gpm-p/22031

 

An example of using the REST API to get the IDs of all Subscriptions is as follows:
zoql_with_postman.png

 

We can write ZOQL as value of the "queryString" in the request body. ZOQL grammar is exactly the same in both SOAP and REST.