REST API Developer Guide

Introduction to REST API
Quick Start
Examples
Generating an OpenAPI 3.0 Document for sObjects REST API (Beta)
Reference
Versions
Resources by Version
Limits
Describe Global
sObject Basic Information
sObject Describe
sObject Get Deleted
sObject Get Updated
sObject Named Layouts
sObject Rows
sObject Rows by External ID
sObject Blob Get
sObject ApprovalLayouts
sObject Single Approval Process
sObject CompactLayouts
sObject Layouts
sObject Layouts for an Object With Multiple Record Types
sObject Global Publisher Layouts
sObject PlatformAction
sObject Quick Actions
sObject Specific Quick Actions
sObject Quick Action Details
sObject Quick Action Default Values
sObject Quick Action Default Values by ID
sObject Rich Text Image Get
sObject Relationships
sObjects Suggested Articles
sObjects Suggested Articles by ID
sObject User Password
sObject Self-Service User Password
Platform Event Schema by Event Name
Platform Event Schema by Schema ID
Get AppMenu Types
AppMenu Items
AppMenu Mobile Items
Compact Layouts
Consent
Consent Write
Embedded Service Configuration Describe
Invocable Actions
Invocable Actions Custom
Invocable Actions Standard
List View Basic Information
List View Describe
List View Results
List Views for an Object
Named Query APIs for SOQL Queries
Support Knowledge with REST API
Parameterized Search
Portability
Process Approvals
Process Rules
Process Rule for an sObject
Process Rule List for an sObject
Product Schedules
Query
Query More Results
QueryAll
QueryAll More Results
Query Performance Feedback (Beta)
Quick Actions
Recent List Views
Recently Viewed Items
Record Count
sObject Relevant Items
Get Knowledge Language Settings
Search
Search Scope and Order
Search Result Layouts
Lightning Toggle Metrics
Lightning Usage by App Type
Lightning Usage by Browser
Lightning Usage by Page
Lightning Usage by FlexiPage
Lightning Exit by Page Metrics
Salesforce Scheduler Resources
Search for Records Suggested by Autocomplete and Instant Results
Search Suggested Article Title Matches
Search Suggested Queries
Salesforce Surveys Translation Resources
Tabs
Themes
Composite
Composite Graph
Composite Batch
sObject Tree
sObject Collections
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

sObject Describe

Completely describes the individual metadata at all levels for the specified object. For example, this can be used to retrieve the fields, URLs, and child relationships for the Account object.

For more information about the metadata that is retrieved, see DescribesObjectResult in the SOAP API Developers Guide.

You can use the If-Modified-Since or If-Unmodified-Since header with this resource. When using the If-Modified-Since header, if no available object’s metadata has changed since the provided date, a 304 Not Modified status code is returned with no response body.

Syntax

URI: /services/data/vXX.X/sobjects/sObject/describe/

Formats: JSON, XML

HTTP Method: GET

Authentication: Authorization: Bearer token

Parameters

Parameter Description
sObject The name of the object. For example, Account. A required path parameter.
If-Modified-Since An optional header specifying a date and time. The request returns records that have been modified after that date and time. The format is EEE, dd MMM yyyy HH:mm:ss z. For example: If-Modified-Since: Mon, 30 Nov 2020 08:34:54 MST.
If-Unmodified-Since An optional header specifying a date and time. The request returns records that have not been modified after that date and time. The format is EEE, dd MMM yyyy HH:mm:ss z. For example: If-Unmodified-Since: Mon, 30 Nov 2020 08:34:54 MST.

Example

See Get Field and Other Metadata for an Object. For an example that uses the If-Modified-Since HTTP header, see Get Object Metadata Changes.