Salesforce

Salesforce Describe API

The Describe API from Salesforce — 13 operation(s) for describe.

GitHub OpenAPI

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /data/v64.0/tooling/sobjects/EventRelayConfig/describe Describe the EventRelayConfig object · Salesforce Describe Event Relay #
Ask an LLM
“What fields does an event relay configuration have?”
“Can I describe EventRelayConfig through the Tooling API before creating a relay?”
Tell an agent
Describe the EventRelayConfig Tooling object.
List the fields available when configuring an event relay.
GET /data/v64.0/sobjects/EventRelayFeedback/describe Describe the EventRelayFeedback object · Salesforce Describe Event Felay Feedback #
Ask an LLM
“Which fields report an event relay's status and errors?”
“Can I see the shape of EventRelayFeedback records?”
Tell an agent
Describe the EventRelayFeedback object.
Show the fields that event relay feedback records carry.
GET /data/v64.0/tooling/sobjects/ManagedEventSubscription/describe Describe the ManagedEventSubscription object · Salesforce Describe Managed Event Subscription #
Ask an LLM
“What fields make up a managed event subscription?”
“Can I describe ManagedEventSubscription before subscribing to platform events?”
Tell an agent
Describe the ManagedEventSubscription Tooling object.
List the fields needed to define a managed event subscription.
GET /data/v64.0/sobjects List every object in the org · Salesforce Describe Global #
Ask an LLM
“Which standard and custom objects exist in my Salesforce org?”
“What is the maximum batch size my org allows in queries?”
Tell an agent
List all objects available in my org with their metadata.
Show the org encoding and every sObject I can access.
GET /data/v64.0/sobjects/{SOBJECT_API_NAME}/describe Describe an object's fields in full · Salesforce Sobject Describe #
Ask an LLM
“What are all the fields, picklist values and relationships on Opportunity?”
“Can I get the complete field-level describe for a custom object?”
Tell an agent
Describe the {object} object in full.
List every field with its type and picklist values on {object}.
GET /data/v64.0/sobjects/Global/describe/layouts Describe global publisher layouts · Salesforce Describe Global Layouts #
Ask an LLM
“What global quick-action layouts are defined in my org?”
“Can I list the global layouts and their fields?”
Tell an agent
Describe the global layouts in my org.
Show the fields on each global publisher layout.
GET /data/v64.0/sobjects/{SOBJECT_API_NAME}/describe/layouts Describe all layouts for an object · Salesforce Describe Sobject Layouts #
Ask an LLM
“Which page layouts are assigned for the Lead object?”
“Can I list every layout of an object with its fields?”
Tell an agent
Describe the layouts for {object}.
List each page layout name and its fields on {object}.
GET /data/v64.0/sobjects/{SOBJECT_API_NAME}/describe/layouts/{RECORD_TYPE_ID} Describe an object's layout for one record type · Salesforce Describe Sobject Layouts Per Record Type #
Ask an LLM
“What layout does a specific record type of Case use?”
“Can I describe the page layout tied to one record type ID?”
Tell an agent
Describe the {object} layout for record type {record_type}.
Show the fields on the layout record type {record_type} uses for {object}.
GET /data/v64.0/sobjects/{SOBJECT_API_NAME}/listviews/{QUERY_LOCATOR}/describe Describe a list view's columns and SOQL · Salesforce List View Describe #
Ask an LLM
“What SOQL query sits behind a list view?”
“Can I see a list view's ID and columns from the sObject describe resource?”
Tell an agent
Describe list view {list_view} on {object} including its SOQL.
Show the columns and underlying query of the {object} list view {list_view}.
GET /data/v64.0/tooling/sobjects List all Tooling API objects · Salesforce Get Tooling Describe #
Ask an LLM
“Which objects does the Tooling API expose?”
“Can I get a global describe of Tooling API metadata types?”
Tell an agent
List every Tooling API object and its metadata.
Run a Tooling API global describe.
GET /data/v64.0/tooling/sobjects/{SOBJECT_API_NAME}/describe Describe a Tooling API object's fields · Salesforce Get Tooling Describe Sobject #
Ask an LLM
“What fields does the ApexClass Tooling object have?”
“Can I get a full describe of a Tooling API sObject?”
Tell an agent
Describe the Tooling API object {object}.
List all fields on Tooling object {object}.

Documentation

📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/get_job_info.htm
📖
Authentication
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/bulk_api_2_0_security.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started.htm
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list.htm
📖
Documentation
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/rest-api.html
📖
GettingStarted
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/get-started-spec.html
📖
APIReference
https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_overview.html
📖
Authentication
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/access-token-s2s.html
📖
Documentation
https://developer.salesforce.com/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/salesforce/openapi/salesforce-describe-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/salesforce/json-schema/salesforce-bulk-job-schema.json

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/salesforce:salesforce-describe-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

OpenAPI Specification

salesforce-describe-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Salesforce Describe API
  description: Find the resources you need to start building.
  contact: {}
  version: '1.0'
servers:
- url: https://login.salesforce.com
  variables: {}
- url: https://id
  variables: {}
- url: https://services
  variables: {}
- url: '{{url}}{{site}}/services/oauth2'
  variables:
    url:
      default: DefaultParameterValue
    site:
      default: DefaultParameterValue
security:
- oauth2:
  - api
tags:


# --- truncated at 32 KB (100 KB total) ---
# Full source: https://artifacts.apis.io/salesforce/openapi/salesforce-describe-api-openapi.yml