Salesforce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Salesforce Applications API

8 actions 8 updates phrasing extends openapi/salesforce-applications-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 8

$.info
$.paths['/services/data/v64.0/apps/oauth/usage//users'].get
$.paths['/services/data/v64.0/apps/oauth/usage///tokens'].get
$.paths['/data/v64.0/sobjects/LightningUsageByAppTypeMetrics'].get
$.paths['/data/v64.0/ui-api/apps'].get
$.paths['/data/v64.0/ui-api/apps/{APP_ID}'].get
$.paths['/data/v64.0/ui-api/apps/{APP_ID}'].patch
$.paths['/data/v64.0/ui-api/apps/selected'].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 Applications API
  version: 1.0.0
extends: openapi/salesforce-applications-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: 7
- target: $.paths['/services/data/v64.0/apps/oauth/usage//users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users of an external client app
      effect: read
      questions:
      - Which users have authorized my external client app?
      - Can I page through the users of an OAuth app 100 at a time?
      instructions:
      - text: List the users of my external client app, page {page}.
        slots:
          page: query.page
      - text: Show OAuth app users with {pageSize} per page.
        slots:
          pageSize: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/data/v64.0/apps/oauth/usage///tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's tokens for an OAuth app
      effect: read
      questions:
      - What refresh tokens does a user hold for my external client app?
      - Can I see every token issued to one user of an OAuth app?
      instructions:
      - text: List a user's tokens for my external client app.
      - text: Show the refresh tokens one user has for the OAuth app.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/sobjects/LightningUsageByAppTypeMetrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Count Lightning and mobile users
      effect: read
      questions:
      - How many users are on Lightning Experience versus the mobile app?
      - Where can I get total Lightning and Salesforce Mobile user counts?
      instructions:
      - text: Get Lightning usage counts by app type.
      - text: Show how many Lightning Experience and mobile users we have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/apps'].get
  update:
    x-apievangelist-phrasing:
      intent: List the apps a user can access
      effect: read
      questions:
      - Which apps can the current user access?
      - Can I get app metadata tailored to a small form factor like a phone?
      instructions:
      - text: List the apps I can access on the {formFactor} form factor.
        slots:
          formFactor: query.formFactor
      - text: Get metadata for all my apps for {formFactor} screens.
        slots:
          formFactor: query.formFactor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/apps/{APP_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata for one app
      effect: read
      questions:
      - What tabs and metadata does a specific app have?
      - Is there a way to read one app's navigation details by its ID?
      instructions:
      - text: Get metadata for app {APP_ID} on {formFactor}.
        slots:
          APP_ID: path.APP_ID
          formFactor: query.formFactor
      - text: Show the navigation tabs of app {APP_ID}.
        slots:
          APP_ID: path.APP_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/apps/{APP_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Save an app as the last selected
      effect: write
      questions:
      - Can I set which app a user last selected so it opens by default?
      - How do I switch the user's current app programmatically?
      instructions:
      - text: Mark app {APP_ID} as my last selected app for {formFactor}.
        slots:
          APP_ID: path.APP_ID
          formFactor: query.formFactor
      - text: Switch my selected app to {APP_ID}.
        slots:
          APP_ID: path.APP_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/apps/selected'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the user's last selected app
      effect: read
      questions:
      - Which app did the user last select or see by default?
      - What app will open for me when I log in on a phone?
      instructions:
      - text: Get my last selected app for {formFactor}.
        slots:
          formFactor: query.formFactor
      - text: Tell me which app is currently selected on {formFactor}.
        slots:
          formFactor: query.formFactor
      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-applications-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.

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