Removal of the /*/find, /searchResults, and /searchResults/field endpoints, replaced by 6 new endpoints

What will change?

We have now deprecated and will soon be removing the following 6 API endpoints:

• GET /deals/find - Searches all deals by their title
• GET /persons/find - Searches all persons by their name
• GET /organizations/find - Searches all organizations by their name
• GET /products/find - Returns data about the products that were found.
• GET /searchResults - Searches all items or 1 item by all fields
• GET /searchResults/field - searches 1 item type by 1 field

We strongly advise you to avoid the use of these 6 deprecated API endpoints.

 <p><b> Why?</b></p>

We are introducing 6 new endpoints:

• GET /itemSearch
• GET /itemSearch/field
• GET /deals/search
• GET /persons/search
• GET /organizations/search
• GET /products/search

The new Search API endpoints offer extended functionality over the old search API and have a unified future-proof response format. The extended functionality allows you to do complicated queries from several item types and fields at once.

For example you can use /v1/itemSearch?item_types=deal,person&fields=title,name,custom_fields&term=example to search from all persons and deals by the person’s name, deal title and both items custom fields and order them by relevance.

The /*/search endpoints are aliases for /v1/itemSearch?item_types=* endpoint with narrower OAuth2 scopes for if you are a marketplace app owner and would like your app to only have read access to specific item types instead of the full search scope.

 <p><b> Who is affected?</b></p>
  <p>Anyone depending on the previously listed 6 <b>deprecated</b> endpoints in any way is affected. In case you are using the previously listed 6 <b>deprecated</b> API endpoints in your code or 3rd party app/integration, please remove any dependency on these endpoints as soon as possible, or by <b>March 31, 2021</b> the latest. For additional help, check out <a href="/docs/new-search-api-migration-guide">new search API migration guide</a>. </p>

    <p class="published-on"><i>Published on April 8, 2020</i></p>
</div>