When retrieving entries using the Octopus API Read methods such as AbEntryRead, OpportunityRead, or TaskRead, you may filter the results that the method returns by passing a search query to the Read method. In this way, you can limit the volume of data transferred over the network by only retrieving the records you actually need.
Search criteria are passed to the Read methods via the Criteria object nested within the main object of the request. Octopus API search queries are specified using a SearchQuery object that follows the Search Query syntax described below.
This section outlines the v2 search query syntax. Search query syntax v2 was added in API version 2.7. If you are using a previous API version, refer to the documentation for the v1 search query syntax.
For more examples, please use our public Postman collections.