Working with Searches and Queries

The examples in this section use REST API resources to search and query records using Salesforce Object Search Language (SOSL) and Salesforce Object Query Language (SOQL), and other search APIs.

For more information on SOSL and SOQL see the SOQL and SOSL Reference.

  • Execute a SOQL Query

    Use the Query resource to execute a SOQL query that returns all the results in a single response, or if needed, returns part of the results and a locator used to retrieve the remaining results.

  • Execute a SOQL Query that Includes Deleted Items

    Use the QueryAll resource to execute a SOQL query that includes information about records that have been deleted because of a merge or delete. Use QueryAll rather than Query, because the Query resource will automatically filter out items that have been deleted.

  • Get Feedback on Query Performance (Beta)

    To get feedback on how Salesforce executes your query, report, or list view, use the Query resource along with the explain parameter. Salesforce analyzes each query to find the optimal approach to obtain the query results. Depending on the query and query filters, Salesforce uses an index or internal optimization. To return details on how Salesforce optimizes your query, without actually running the query, use the explain parameter. Based on the response, decide whether to fine-tune the performance of your query, like adding filters to make the query more selective.

  • Search for a String

    Use the Search resource to execute a SOSL search or use the Parameterized Search resource to execute a simple RESTful search without SOSL.

  • Get the Default Search Scope and Order

    Use the Search Scope and Order resource to retrieve the default global search scope and order for the logged-in user, including any pinned objects in the user’s search results page.

  • Get Search Result Layouts for Objects

    Use the Search Result Layouts resource to retrieve the search result layout configuration for each object specified in the query string.

  • Get Relevant Items

    Use the Relevant Items resource to retrieve a list of relevant items.