Salesforce Search API

The Search API from Salesforce — 9 operation(s) for search.

Documentation GitHub OpenAPI

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /data/v64.0/search Run a SOSL search across objects · Salesforce Search #

Ask an LLM

“How do I search for a name across Accounts, Contacts and Leads at once?”

“Does a SOSL search string need to be URL-encoded?”

Tell an agent

Run the SOSL search {sosl}.

Search all objects with the SOSL clause {sosl}.

GET /data/v64.0/parameterizedSearch Search records with simple parameters · Salesforce Parameterized Search #

Ask an LLM

“Can I search Salesforce without writing a SOSL clause?”

“What's the simplest way to do a keyword search over records?”

Tell an agent

Do a parameterized search for {term}.

Find records matching the keyword {term} without SOSL.

GET /data/v64.0/tooling/search Search Tooling API metadata with SOSL · Salesforce Tooling Search #

Ask an LLM

“Can I search Apex classes and other metadata by keyword?”

“Which Tooling API resource runs a SOSL search over code?”

Tell an agent

Search Tooling API metadata with {sosl}.

Run a Tooling SOSL search {sosl} across Apex and metadata.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/salesforce:salesforce-search-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Salesforce Search API
  description: Find the resources you need to start building.
  contact: {}
  version: '1.0'
servers:
- url: https://login.salesforce.com
  variables: {}
- url: https://id
  variables: {}
- url: https://services
  variables: {}
- url: '{{url}}{{site}}/services/oauth2'
  variables:
    url:
      default: DefaultParameterValue
    site:
      default: DefaultParameterValue
security:
- oauth2:
  - api
tags:
- name: Search
paths:
  /data/v64.0/search:
    parameters: []
    get:
      tags:
      - Search
      summary: Salesforce Search
      description: 'Executes the specified SOSL search. The search string must be URL-encoded.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search.htm'
      operationId: Search
      parameters:
      - name: q
        in: query
        description: A SOSL statement that is properly URL-encoded.
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/parameterizedSearch:
    parameters: []
    get:
      tags:
      - Search
      summary: Salesforce Parameterized Search
      description: Executes a simple RESTful search using parameters instead of a SOSL clause. Indicate parameters in a URL in the GET method. Or, use POST for more complex JSON searches.
      operationId: ParameterizedSearch
      parameters:
      - name: q
        in: query
        description: A search string that is properly URL-encoded
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/tooling/search:
    parameters: []
    get:
      tags:
      - Search
      summary: Salesforce Tooling Search
      description: Runs one or more methods within one or more Apex classes, using the asynchronous test execution mechanism. In the request body, you can specify test class names and IDs, suite names and IDs, the maximum number of failed tests to allow, and the test level, as comma-separated lists or as an array. You can also indicate whether to opt out of collecting code coverage information during the test run (available in API version 43.0 and later).
      operationId: ToolingSearch
      parameters:
      - name: q
        in: query
        description: SOSL search statement
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 11 Dec 2023 10:34:10 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Sforce-Limit-Info:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: api-usage=294/15000
            queryId:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: -mxbcxdoqukvy
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/ToolingSearch'
                - examples:
                  - searchRecords:
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqcAAA
                      Name: LightningSelfRegisterController
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqhAAA
                      Name: LightningSelfRegisterControllerTest
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq9AAA
                      Name: SiteRegisterControllerTest
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A0zYxQAJ
                      Name: PrepareSandboxTest
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqTAAQ
                      Name: CommunitiesSelfRegControllerTest
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009aIwvQAE
                      Name: MicrobatchSelfRegControllerTest
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009PEFIQA4
                      Name: PrepareSandbox
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqRAAQ
                      Name: CommunitiesLandingControllerTest
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqFAAQ
                      Name: MyProfilePageControllerTest
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqDAAQ
                      Name: ForgotPasswordControllerTest
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq7AAA
                      Name: SiteLoginControllerTest
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000ANdnqQAD
                      Name: AccountTriggerHelperTest
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqgAAA
                      Name: LightningForgotPasswordControllerTest
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqfAAA
                      Name: LightningLoginFormControllerTest
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqeAAA
                      Name: LightningLoginFormController
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqVAAQ
                      Name: CommunitiesSelfRegConfirmControllerTest
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqPAAQ
                      Name: CommunitiesLoginControllerTest
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqBAAQ
                      Name: ChangePasswordControllerTest
                contentMediaType: application/json;charset=UTF-8
              example:
                searchRecords:
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqcAAA
                  Name: LightningSelfRegisterController
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqhAAA
                  Name: LightningSelfRegisterControllerTest
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq9AAA
                  Name: SiteRegisterControllerTest
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A0zYxQAJ
                  Name: PrepareSandboxTest
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqTAAQ
                  Name: CommunitiesSelfRegControllerTest
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009aIwvQAE
                  Name: MicrobatchSelfRegControllerTest
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009PEFIQA4
                  Name: PrepareSandbox
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqRAAQ
                  Name: CommunitiesLandingControllerTest
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqFAAQ
                  Name: MyProfilePageControllerTest
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqDAAQ
                  Name: ForgotPasswordControllerTest
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq7AAA
                  Name: SiteLoginControllerTest
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000ANdnqQAD
                  Name: AccountTriggerHelperTest
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqgAAA
                  Name: LightningForgotPasswordControllerTest
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqfAAA
                  Name: LightningLoginFormControllerTest
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqeAAA
                  Name: LightningLoginFormController
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqVAAQ
                  Name: CommunitiesSelfRegConfirmControllerTest
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqPAAQ
                  Name: CommunitiesLoginControllerTest
                - attributes:
                    type: ApexClass
                    url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqBAAQ
                  Name: ChangePasswordControllerTest
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    SearchRecord:
      title: SearchRecord
      required:
      - attributes
      - Name
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Attributes4'
        Name:
          type: string
          example: Example Title
      examples:
      - attributes:
          type: ApexClass
          url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqcAAA
        Name: LightningSelfRegisterController
    ToolingSearch:
      title: ToolingSearch
      required:
      - searchRecords
      type: object
      properties:
        searchRecords:
          type: array
          items:
            $ref: '#/components/schemas/SearchRecord'
          description: ''
          example: []
      examples:
      - searchRecords:
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqcAAA
          Name: LightningSelfRegisterController
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqhAAA
          Name: LightningSelfRegisterControllerTest
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq9AAA
          Name: SiteRegisterControllerTest
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A0zYxQAJ
          Name: PrepareSandboxTest
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqTAAQ
          Name: CommunitiesSelfRegControllerTest
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009aIwvQAE
          Name: MicrobatchSelfRegControllerTest
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009PEFIQA4
          Name: PrepareSandbox
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqRAAQ
          Name: CommunitiesLandingControllerTest
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqFAAQ
          Name: MyProfilePageControllerTest
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqDAAQ
          Name: ForgotPasswordControllerTest
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq7AAA
          Name: SiteLoginControllerTest
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000ANdnqQAD
          Name: AccountTriggerHelperTest
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqgAAA
          Name: LightningForgotPasswordControllerTest
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqfAAA
          Name: LightningLoginFormControllerTest
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqeAAA
          Name: LightningLoginFormController
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqVAAQ
          Name: CommunitiesSelfRegConfirmControllerTest
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqPAAQ
          Name: CommunitiesLoginControllerTest
        - attributes:
            type: ApexClass
            url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqBAAQ
          Name: ChangePasswordControllerTest
    Attributes4:
      title: Attributes4
      required:
      - type
      - url
      type: object
      properties:
        type:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
      examples:
      - type: Account
        url: /services/data/v58.0/sobjects/Account/001...
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: '{DefaultParameterValue}{DefaultParameterValue}/services/oauth2/authorize'
          scopes:
            api: ''

Salesforce Search API

Operations 3

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification