How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Salesforce Describe API

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

Salesforce Describe API is one of 294 APIs that Salesforce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Describe. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and 1 JSON Schema.

This API exposes 13 operations across 13 paths, and defines 19 schemas. It is described by OpenAPI 3.1.0, at version v63.0.

Requests are made against a single base URL, https://{instance}.salesforce.com/services/data/v{version}/jobs.

13 operations 13 paths 19 schemas 13 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v63.0
Base URL
https://{instance}.salesforce.com/services/data
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Salesforce Describe API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {accesstoken}".

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 13 GET. Each is listed below with its method, path, parameters, and response codes.

Describe 13
GET
/data/v64.0/tooling/sobjects/PlatformEventChannel/describe
Salesforce Describe Event Channel
Describeeventchannel → 200
GET
/data/v64.0/tooling/sobjects/EventRelayConfig/describe
Salesforce Describe Event Relay
Describeeventrelay → 200
GET
/data/v64.0/sobjects/EventRelayFeedback/describe
Salesforce Describe Event Felay Feedback
Describeeventfelayfeedback → 200
GET
/data/v64.0/tooling/sobjects/ManagedEventSubscription/describe
Salesforce Describe Managed Event Subscription
Describemanagedeventsubscription → 200
GET
/data/v64.0/sobjects
Salesforce Describe Global
DescribeGlobal 1 param → 200
GET
/data/v64.0/sobjects/{SOBJECT_API_NAME}/describe
Salesforce Sobject Describe
SObjectDescribe 2 params → 200
GET
/data/v64.0/sobjects/Global/describe/layouts
Salesforce Describe Global Layouts
DescribeGlobalLayouts 1 param → 200
GET
/data/v64.0/sobjects/{SOBJECT_API_NAME}/describe/layouts
Salesforce Describe Sobject Layouts
DescribeSObjectLayouts 2 params → 200
GET
/data/v64.0/sobjects/{SOBJECT_API_NAME}/describe/layouts/{RECORD_TYPE_ID}
Salesforce Describe Sobject Layouts Per Record Type
DescribeSObjectLayoutsPerRecordType 3 params → 200
GET
/data/v64.0/sobjects/{SOBJECT_API_NAME}/listviews/{QUERY_LOCATOR}/describe
Salesforce List View Describe
ListViewDescribe 3 params → 200
GET
/data/v64.0/support/embeddedservice/configuration/{EMBEDDED_SERVICE_CONFIG_DEVELOPERNAME}
Salesforce Embedded Service Configuration Describe
EmbeddedServiceConfigurationDescribe 2 params → 200
GET
/data/v64.0/tooling/sobjects
Salesforce Get Tooling Describe
GetToolingDescribe → 200
GET
/data/v64.0/tooling/sobjects/{SOBJECT_API_NAME}/describe
Salesforce Get Tooling Describe Sobject
GetToolingDescribeSObject 1 param → 200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Fields2 (57 properties), Field9 (57 properties), Field1 (57 properties), Describeeventchannel (45 properties). Each schema is shown below with its type and property counts.

Urls8
object
8 properties 8 required
Fields2
object
57 properties 57 required
GetToolingDescribeSObject
object
45 properties 45 required
Urls2
object
3 properties 3 required
PicklistValue31
object
5 properties 5 required
GetToolingDescribe
object
3 properties 3 required
SupportedScope
object
2 properties 2 required
SObjectDescribe
object
45 properties 45 required
ActionOverride
object
5 properties 5 required
Urls3
object
1 property 1 required
Field1
object
57 properties 57 required
Sobjects2
object
28 properties 28 required
Urls4
object
11 properties 11 required
PicklistValue
object
5 properties
Describeeventchannel
object
45 properties 45 required
Field9
object
57 properties 57 required
ChildRelationship
object
8 properties 8 required
PicklistValue1
object
5 properties 5 required
RecordTypeInfo
object
8 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

salesforce-describe-api-openapi.yml Raw ↑

Other APIs Salesforce publishes across the network.

Salesforce REST API
Salesforce SOAP API
Salesforce Bulk API
Salesforce Streaming API
Salesforce Metadata API
Salesforce Tooling API
Salesforce Connect API (Chatter)
Salesforce Analytics REST API
Salesforce Reports and Dashboards REST API
Salesforce Einstein Platform Services API
Salesforce Einstein Prediction Service API
Salesforce GraphQL API
Where this information came from

This is an independent, third-party profile of Salesforce Describe API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.