Salesforce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Salesforce Search API

4 actions 4 updates phrasing extends openapi/salesforce-search-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Salesforce's API. It is a proposal applied on top of the contract, not a document Salesforce publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/data/v64.0/search'].get
$.paths['/data/v64.0/parameterizedSearch'].get
$.paths['/data/v64.0/tooling/search'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce Search API
  version: 1.0.0
extends: openapi/salesforce-search-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/data/v64.0/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a SOSL search across objects
      effect: read
      questions:
      - How do I search for a name across Accounts, Contacts and Leads at once?
      - Does a SOSL search string need to be URL-encoded?
      instructions:
      - text: Run the SOSL search {sosl}.
        slots:
          sosl: query.q
      - text: Search all objects with the SOSL clause {sosl}.
        slots:
          sosl: query.q
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/parameterizedSearch'].get
  update:
    x-apievangelist-phrasing:
      intent: Search records with simple parameters
      effect: read
      questions:
      - Can I search Salesforce without writing a SOSL clause?
      - What's the simplest way to do a keyword search over records?
      instructions:
      - text: Do a parameterized search for {term}.
        slots:
          term: query.q
      - text: Find records matching the keyword {term} without SOSL.
        slots:
          term: query.q
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Tooling API metadata with SOSL
      effect: read
      questions:
      - Can I search Apex classes and other metadata by keyword?
      - Which Tooling API resource runs a SOSL search over code?
      instructions:
      - text: Search Tooling API metadata with {sosl}.
        slots:
          sosl: query.q
      - text: Run a Tooling SOSL search {sosl} across Apex and metadata.
        slots:
          sosl: query.q
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • 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 overlay 
curl "https://apis.io/api/v1/overlays/salesforce-search-api-phrasing-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.