Salesforce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Salesforce Field API

4 actions 4 updates phrasing extends openapi/salesforce-field-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/ui-api/object-info/{SOBJECT_API_NAME}/picklist-values/{RECORD_TYPE_ID}/{FIELD_API_NAME}'].get
$.paths['/data/v64.0/ui-api/lookups/{SOBJECT_API_NAME}/{FIELD_API_NAME}'].get
$.paths['/data/v64.0/ui-api/lookups/{SOBJECT_API_NAME}/{FIELD_API_NAME}/{TARGET_API_NAME}'].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 Field API
  version: 1.0.0
extends: openapi/salesforce-field-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/ui-api/object-info/{SOBJECT_API_NAME}/picklist-values/{RECORD_TYPE_ID}/{FIELD_API_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get picklist values for a field
      effect: read
      questions:
      - What values can a picklist field take for a given record type?
      - How do I get the allowed Stage values for Opportunity picklists?
      instructions:
      - text: Get picklist values of {field} on {sobject} for record type {record_type_id}.
        slots:
          field: path.FIELD_API_NAME
          sobject: path.SOBJECT_API_NAME
          record_type_id: path.RECORD_TYPE_ID
      - text: List allowed values for picklist {field} in record type {record_type_id} of {sobject}.
        slots:
          field: path.FIELD_API_NAME
          sobject: path.SOBJECT_API_NAME
          record_type_id: path.RECORD_TYPE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/lookups/{SOBJECT_API_NAME}/{FIELD_API_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get lookup field suggestions
      effect: read
      questions:
      - How do I show suggestions when a user types into a lookup field?
      - Can lookup suggestions return recently used matches?
      instructions:
      - text: Get lookup suggestions for field {field} on {sobject}.
        slots:
          field: path.FIELD_API_NAME
          sobject: path.SOBJECT_API_NAME
      - text: Suggest matching records for the {field} lookup of {sobject}.
        slots:
          field: path.FIELD_API_NAME
          sobject: path.SOBJECT_API_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/lookups/{SOBJECT_API_NAME}/{FIELD_API_NAME}/{TARGET_API_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get lookup suggestions for one target object
      effect: read
      questions:
      - For a polymorphic lookup, how do I get suggestions from just one target object?
      - Can I restrict lookup suggestions on the Owner field to users only?
      instructions:
      - text: Get {field} lookup suggestions on {sobject} limited to target {target}.
        slots:
          field: path.FIELD_API_NAME
          sobject: path.SOBJECT_API_NAME
          target: path.TARGET_API_NAME
      - text: Suggest {target} records for lookup {field} on {sobject}.
        slots:
          field: path.FIELD_API_NAME
          sobject: path.SOBJECT_API_NAME
          target: path.TARGET_API_NAME
      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-field-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.