API Evangelist conversational phrasing for Salesforce Get API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce Get API
  version: 1.0.0
extends: openapi/salesforce-get-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: 26
- target: $.paths['/services/oauth2/userinfo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the signed-in user's OAuth profile
      effect: read
      questions:
      - Which user does my Salesforce access token belong to?
      - Can I read the signed-in user's email and org ID from the standard userinfo endpoint?
      instructions:
      - text: Look up who owns my current access token using the services/oauth2 userinfo endpoint.
      - text: Show the name, email and org of the user behind this OAuth session.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/jobs/query/'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a Bulk API 2.0 query job
      effect: read
      questions:
      - Has my bulk query job finished yet, or is it still in progress?
      - What state is a Bulk API 2.0 query job in, and how many records has it processed?
      instructions:
      - text: Check the progress of my Bulk API 2.0 query job.
      - text: Tell me whether the bulk query extract job is JobComplete yet.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/jobs/query//results'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the results of a bulk query job
      effect: read
      questions:
      - Where do I download the CSV rows a completed bulk query job extracted?
      - Can I pull the records produced by a finished Bulk API 2.0 query as a file?
      instructions:
      - text: Download the result rows of my completed bulk query job.
      - text: Fetch the extracted CSV data from the finished query job.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/jobs/query//resultPages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get result page links for parallel download
      effect: read
      questions:
      - Can I download bulk query results in parallel instead of one page at a time?
      - How many result pages does a query job hand back for parallel download?
      instructions:
      - text: Get up to 5 result page locators for my query job so I can download them in parallel.
      - text: List the parallel download pages for the finished bulk query.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/jobs/ingest/'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a Bulk API 2.0 ingest job
      effect: read
      questions:
      - Is my bulk data load (ingest job) finished, and did any records fail?
      - What does an ingest job report about records processed so far?
      instructions:
      - text: Check the state of my Bulk API 2.0 ingest job.
      - text: Show how far along the bulk upload job is.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/jobs/ingest//successfulResults'].get
  update:
    x-apievangelist-phrasing:
      intent: Get records an ingest job loaded successfully
      effect: read
      questions:
      - Which rows from my bulk upload were saved successfully?
      - Can I get the IDs of the records a Bulk API 2.0 ingest job created or updated?
      instructions:
      - text: Download the successful record results for my ingest job.
      - text: Give me the rows that loaded without errors in the bulk data load.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/jobs/ingest//unprocessedrecords'].get
  update:
    x-apievangelist-phrasing:
      intent: Get records an ingest job never processed
      effect: read
      questions:
      - Which rows in my bulk upload were never processed because the job was aborted or failed?
      - Can I retrieve the unprocessed records from an ingest job so I can resubmit them?
      instructions:
      - text: Download the unprocessed records from my ingest job.
      - text: List the rows the bulk data load skipped so I can retry them.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/connect/business-rules/decision-table/definitions/{decisionTableId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a decision table definition
      effect: read
      questions:
      - What conditions and outputs does a business-rules decision table define?
      - Can I read the definition of a decision table by its ID?
      instructions:
      - text: Show me the definition of decision table {decisionTableId}.
        slots:
          decisionTableId: path.decisionTableId
      - text: Get the input and output columns configured on decision table {decisionTableId}.
        slots:
          decisionTableId: path.decisionTableId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/einstein/ai-evaluations/runs/{runId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of an AI evaluation run
      effect: read
      questions:
      - Is my Einstein AI evaluation test run still running?
      - What status does an AI evaluation run report while it executes?
      instructions:
      - text: Check the status of AI evaluation run {runId}.
        slots:
          runId: path.runId
      - text: Tell me whether Einstein evaluation run {runId} has finished.
        slots:
          runId: path.runId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/einstein/ai-evaluations/runs/{runId}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of an AI evaluation run
      effect: read
      questions:
      - What were the results of my Einstein AI evaluation test?
      - Can I see the per-test outcomes of a finished AI evaluation run?
      instructions:
      - text: Get the results of AI evaluation run {runId}.
        slots:
          runId: path.runId
      - text: Show the scored outcomes from Einstein evaluation run {runId}.
        slots:
          runId: path.runId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apexrest/{NAMESPACE}/v1/integrationprocedure/{TYPE_SUBTYPE}'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an integration procedure with a GET call
      effect: read
      questions:
      - Can I invoke an OmniStudio integration procedure with a simple GET request?
      - What do I need to call an integration procedure by its type and subtype?
      instructions:
      - text: Invoke integration procedure {type_subtype} in namespace {namespace} via GET.
        slots:
          type_subtype: path.TYPE_SUBTYPE
          namespace: path.NAMESPACE
      - text: Call the {type_subtype} integration procedure under the {namespace} Apex REST namespace.
        slots:
          type_subtype: path.TYPE_SUBTYPE
          namespace: path.NAMESPACE
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/sobjects/{SOBJECT_API_NAME}/deleted'].get
  update:
    x-apievangelist-phrasing:
      intent: List records deleted in a time window
      effect: read
      questions:
      - Which Account records were deleted in the last week?
      - Can I find records of an object that were deleted between two dates for a sync?
      instructions:
      - text: List {object} records deleted between {start} and {end}.
        slots:
          object: path.SOBJECT_API_NAME
          start: query.start
          end: query.end
      - text: Find which {object} rows were removed since {start}, up to {end}.
        slots:
          object: path.SOBJECT_API_NAME
          start: query.start
          end: query.end
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/sobjects/{SOBJECT_API_NAME}/updated'].get
  update:
    x-apievangelist-phrasing:
      intent: List records updated in a time window
      effect: read
      questions:
      - Which Contacts were added or changed since yesterday?
      - Can I get the IDs of records modified between two timestamps to keep a copy in sync?
      instructions:
      - text: List {object} records updated between {start} and {end}.
        slots:
          object: path.SOBJECT_API_NAME
          start: query.start
          end: query.end
      - text: Find the {object} records that were created or modified from {start} to {end}.
        slots:
          object: path.SOBJECT_API_NAME
          start: query.start
          end: query.end
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/list-info/{SOBJECT_API_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the list views for an object
      effect: read
      questions:
      - What list views exist for Opportunities?
      - Can I see every saved list view defined on an object?
      instructions:
      - text: List the list views available on {object}.
        slots:
          object: path.SOBJECT_API_NAME
      - text: Show me all saved list views for the {object} object.
        slots:
          object: path.SOBJECT_API_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/list-records/{LIST_VIEW_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the records in a list view by its ID
      effect: read
      questions:
      - Can I pull the rows shown in a list view if I only have its ID?
      - What records does list view 00B... currently show?
      instructions:
      - text: Get the records in list view {list_view_id}.
        slots:
          list_view_id: path.LIST_VIEW_ID
      - text: Show the rows returned by the list view with ID {list_view_id}.
        slots:
          list_view_id: path.LIST_VIEW_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/list-records/{SOBJECT_API_NAME}/{LIST_VIEW_API_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the records in a list view by API name
      effect: read
      questions:
      - How do I get the records in the 'AllAccounts' list view using its API name?
      - Can I fetch list view rows by object and list view developer name instead of an ID?
      instructions:
      - text: 'Fetch rows by developer name: the {list_view} list view of {object}.'
        slots:
          list_view: path.LIST_VIEW_API_NAME
          object: path.SOBJECT_API_NAME
      - text: Show the rows of {object} list view {list_view} using URL parameters.
        slots:
          object: path.SOBJECT_API_NAME
          list_view: path.LIST_VIEW_API_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/list-records/{SOBJECT_API_NAME}/{LIST_VIEW_API_NAME}'].post
  update:
    x-apievangelist-phrasing:
      intent: Query list view records with a filter body
      effect: read
      questions:
      - Can I add my own filter, search term and sort order when reading a list view's records?
      - Is there a way to page through a list view with a custom page size and extra where clause?
      instructions:
      - text: Get {object} list view {list_view} records matching {search}, sorted by {sort}.
        slots:
          object: path.SOBJECT_API_NAME
          list_view: path.LIST_VIEW_API_NAME
          search: requestBody.searchTerm
          sort: requestBody.sortBy
      - text: Read {page_size} rows of list view {list_view} on {object} filtered by {where}.
        slots:
          page_size: requestBody.pageSize
          list_view: path.LIST_VIEW_API_NAME
          object: path.SOBJECT_API_NAME
          where: requestBody.where
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/list-info/{LIST_VIEW_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a list view's columns and filters by ID
      effect: read
      questions:
      - What columns, filters and sort order does a given list view ID use?
      - Can I read a list view's definition without its records?
      instructions:
      - text: Get the metadata for list view {list_view_id}.
        slots:
          list_view_id: path.LIST_VIEW_ID
      - text: Show the columns and filter criteria configured on list view {list_view_id}.
        slots:
          list_view_id: path.LIST_VIEW_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/list-info/{SOBJECT_API_NAME}/{LIST_VIEW_API_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a list view's columns and filters by API name
      effect: read
      questions:
      - Which filters does the 'MyOpenCases' list view apply?
      - Can I read a list view's definition by its object and developer name?
      instructions:
      - text: Using developer names, describe list view {list_view} on {object}.
        slots:
          list_view: path.LIST_VIEW_API_NAME
          object: path.SOBJECT_API_NAME
      - text: Describe the columns and sort of {object} list view {list_view}.
        slots:
          object: path.SOBJECT_API_NAME
          list_view: path.LIST_VIEW_API_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/SandboxInfo/{SANDBOX_INFO_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sandbox's details
      effect: read
      questions:
      - What license type and description does one of my sandboxes have?
      - Can I look up a sandbox record through the Tooling API?
      instructions:
      - text: Get sandbox info record {sandbox_id}.
        slots:
          sandbox_id: path.SANDBOX_INFO_ID
      - text: Show me the settings of the sandbox with SandboxInfo ID {sandbox_id}.
        slots:
          sandbox_id: path.SANDBOX_INFO_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/{SOBJECT_API_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get basic info for a Tooling API object
      effect: read
      questions:
      - What recent items and URLs does a Tooling API object like ApexClass expose?
      - Can I get the summary info for a Tooling API sObject type?
      instructions:
      - text: Get the basic Tooling API information for {object}.
        slots:
          object: path.SOBJECT_API_NAME
      - text: Show the Tooling object summary and recent records for {object}.
        slots:
          object: path.SOBJECT_API_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/layout/{SOBJECT_API_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get page layout metadata for an object
      effect: read
      questions:
      - Which sections and fields appear on the Account page layout?
      - Can I read an object's page layout the way Lightning renders it?
      instructions:
      - text: Get the UI API page layout metadata for {object}.
        slots:
          object: path.SOBJECT_API_NAME
      - text: Show the sections and field placement on the {object} record layout.
        slots:
          object: path.SOBJECT_API_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/object-info/{SOBJECT_API_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get UI metadata for an object
      effect: read
      questions:
      - What fields, record types and child relationships does the Case object have?
      - Can I get an object's theme and field labels for building a custom UI?
      instructions:
      - text: Get the UI API object info for {object} from the data/v64.0 endpoint.
        slots:
          object: path.SOBJECT_API_NAME
      - text: List the fields, record types and theme of the {object} object.
        slots:
          object: path.SOBJECT_API_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/records/{RECORD_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one record's data
      effect: read
      questions:
      - Can I fetch a single record's field values with the UI API?
      - What data does record 001... hold right now?
      instructions:
      - text: Get record {record_id}.
        slots:
          record_id: path.RECORD_ID
      - text: Show the field values of the record with ID {record_id}.
        slots:
          record_id: path.RECORD_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/favorites'].get
  update:
    x-apievangelist-phrasing:
      intent: List my favorites
      effect: read
      questions:
      - Which records and pages have I starred as favorites?
      - Can I list every favorite a user has saved in Lightning?
      instructions:
      - text: List all of my favorites.
      - text: Show the favorites saved for the current user in their sort order.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/apps/{APP_ID}/user-nav-items'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's personalized navigation tabs
      effect: read
      questions:
      - Which tabs has a user personalized in the navigation bar of an app?
      - Can I read the user-customized nav items for a Lightning app?
      instructions:
      - text: Get my personalized navigation items for app {app_id}.
        slots:
          app_id: path.APP_ID
      - text: List the tabs in the navigation bar of app {app_id} for the current user.
        slots:
          app_id: path.APP_ID
      method: generated
      generated: '2026-09-26'