Question really says it all. The /opportunitiesendpoint doesn’t seem to offer filtering by contact_id. The UI is able to do this, so I’m hoping that means there is some way to do it via API that I’ve just overlooked.
My biggest gripe with the REST API is the poor querying capabilities. Neither REST v1 nor v2 have the ability to search by Contact ID.
But with the XML-RPC API you can filter by Contact ID by querying the “Lead” table.
Thanks for bringing this up, Jim. Currently, it’s not possible to retrieve opportunities by contact via the v2 API. I’ll report this gap and share an update once it’s resolved.
Gap? There are dozens upon dozens of gaps with most of the REST API Endpoints. They still fail the match the XML-RPC querying capabilities.
@Pav We’ve worked hard to align v2 with the XML-RPC capabilities. We’re working on the gaps identified in our analysis and always welcome feedback. If you spot any specific gap, we’d be happy to take a look.
It would be helpful to know on what gaps have been identified, because REST v2 seems to be much of a clone of the REST v1 querying capabilities.
XML-RPC offers far better querying capabilities, because it feels similar to running a SQL Select statement. There are many fields in the tables that can be queried on, and can be done in different ways.
Before you engaged in the community, we had Tom mentioning that Custom Field querying is not available in REST. That is a step backwards, whereas it can be done in XML-RPC.
I know in the future that the company will want to phase out XML-RPC. If those query parameters are not improved on, a lot of developers will be complaining when they try to migrate across.
@Pav We decided not to include custom field filtering in v2 for now, since there isn’t a performant way to support it. Could you share what kinds of queries you typically run in XML-RPC that you’re not able to do in v2, and what you’re trying to accomplish with them? Understanding that would help us better identify potential gaps and areas for improvement.
@OmarAlmonte - Millions of XML-RPC API calls are being performed every month. All the necessary data is present within your own system. You would be able to see what types of querying that is being performed with XML-RPC.
Here are examples of other gaps.
-
REST Improvements - REST v2 - Improvements Request - Examples given in there, but repeated here.
-
Wildcard querying - https://integ
ration.keap.com/t/wildcard-filtering-in-rest-v2/93418 - This can be achieved with the XML-RPC and is useful when you are trying to find partial text. -
Product SKU querying - Can I retrieve a product by SKU when using the PHP SDK? - #3 by OmarAlmonte
There will be several others that have been requested over the years within this community and support tickets.
@Pav I’ve addressed your questions and feedback in this post so we can keep everything in one place: REST v2 - Improvements Request