Searching in Octopus API

Searches in Octopus API Read are performed using Octopus API search queries. Octopus API search queries are represented as JSON objects containing the criteria to be used for the search. The search query is passed to the Read method in the SearchQuery object within the Criteria object in the request.

For example, the following request to search for the company name and last name of all Address Book entries whose company name begins with the letter "A" and whose last name begins with "D":

{
  "AbEntry":{
    "Scope":{
      "Fields":{
        "CompanyName":1,
        "LastName":1
      }
    },
    "Criteria":{
      "SearchQuery":{
        "$AND":[
          {
            "CompanyName":{
              "$LIKE":"A%"
            }
          },
          {
            "LastName":{
              "$LIKE":"D%"
            }
          }
        ]
      }
    }
  }
}