Salesforce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Salesforce Relationships API

2 actions 2 updates phrasing extends openapi/salesforce-relationships-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 2

$.info

$.paths['/data/v64.0/sobjects/{SOBJECT_API_NAME}/{RECORD_ID}/{RELATIONSHIP_FIELD_NAME}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce Relationships API
  version: 1.0.0
extends: openapi/salesforce-relationships-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: 1
- target: $.paths['/data/v64.0/sobjects/{SOBJECT_API_NAME}/{RECORD_ID}/{RELATIONSHIP_FIELD_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get records through a relationship field
      effect: read
      questions:
      - How do I get an Account's Contacts by following the relationship from the Account?
      - Can I traverse a lookup from one record to its related record?
      instructions:
      - text: Get {relationship} records related to {sobject} {record_id}.
        slots:
          relationship: path.RELATIONSHIP_FIELD_NAME
          sobject: path.SOBJECT_API_NAME
          record_id: path.RECORD_ID
      - text: Follow relationship {relationship} from {sobject} record {record_id}.
        slots:
          relationship: path.RELATIONSHIP_FIELD_NAME
          sobject: path.SOBJECT_API_NAME
          record_id: path.RECORD_ID
      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-relationships-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.