REST API Developer Guide

Introducing Lightning Platform REST API
Quick Start
Examples
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 Retrieve
SObject ApprovalLayouts
SObject CompactLayouts
Describe Layouts
SObject PlatformAction
SObject Quick Actions
SObject Rich Text Image Retrieve
SObject Relationships
SObject Suggested Articles
SObject User Password
Platform Event Schema by Event Name
Platform Event Schema by Schema ID
AppMenu
Compact Layouts
Consent
Embedded Service Configuration Describe
Invocable Actions
List View Describe
List View Results
List Views
Support Knowledge with REST API
Parameterized Search
Process Approvals
Process Rules
Product Schedules
Query
QueryAll
Quick Actions
Recent List Views
Recently Viewed Items
Record Count
Relevant Items
Retrieve 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
Lightning 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 Resources
Headers
Status Codes and Error Responses
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Limits

Lists information about limits in your org. For each limit, this resource returns the maximum allocation and the remaining allocation based on usage. This resource is available in REST API version 29.0 and later for API users with the View Setup and Configuration permission. The resource returns these limits:

Limit Label Description
Analytics
ConcurrentAsyncGetReportInstances Concurrent REST API requests for results of asynchronous report runs
ConcurrentSyncReportRuns Concurrent synchronous report runs via REST API
HourlyAsyncReportRuns Hourly asynchronous report runs via REST API
HourlySyncReportRuns Hourly synchronous report runs via REST API
HourlyDashboardRefreshes Hourly dashboard refreshes via REST API
HourlyDashboardResults Hourly REST API requests for dashboard results
HourlyDashboardStatuses Hourly dashboard status requests via REST API
Email
MassEmail Daily number of mass emails that are sent to external email addresses via Apex or APIs
SingleEmail Daily number of single emails that are sent to external email addresses

For orgs created before Spring ’19, the daily limit is enforced only for emails sent via Apex and Salesforce APIs except for the REST API. For orgs created in Spring ’19 and later, the daily limit is also enforced for email alerts, simple email actions, Send Email actions in flows, and REST API. If one of the newly counted emails can’t be sent because your org has reached the limit, we notify you by email and add an entry to the debug logs.

Note
Lightning Platform REST and Bulk APIs
DailyApiRequests Daily API calls
DailyBulkApiBatches (API version 49.0 and later) or DailyBulkApiRequests (API version 48.0 and earlier)

Daily Bulk API and Bulk API 2.0 batches.

In Bulk API, batches are used by both ingest and query operations. In Bulk API 2.0, batches are used only by ingest operations.
DailyBulkV2QueryFileStorageMB Daily storage for queries in Bulk API 2.0 (measured in MB). This limit is available in API version 47.0 and later.
DailyBulkV2QueryJobs Daily number of query jobs in Bulk API 2.0. This limit is available in API version 47.0 and later.
Platform Events
The following values apply only to platform events. They don’t apply to Change Data Capture events.
HourlyPublishedPlatformEvents High-volume platform event notifications published per hour
HourlyPublishedStandardVolumePlatform​Events Standard-volume platform event notifications published per hour

(You can no longer define standard-volume events. New platform events are high volume by default.)
DailyStandardVolumePlatformEvents Daily standard-volume platform event notifications delivered to CometD clients

(You can no longer define standard-volume events. New platform events are high volume by default.)
Platform Events and Change Data Capture
MonthlyPlatformEventsUsageEntitlement (API version 48.0 and later)

Org With Add-On License: Monthly Usage-Based Entitlement

If your org has the high-volume platform event or Change Data Capture add-on, use MonthlyPlatformEventsUsageEntitlement. This value is the monthly entitlement and usage of event delivery to CometD clients and is incremented for each client. This value doesn’t apply to non-CometD subscribers, such as Apex triggers, flows, and processes. This value includes usage for both high-volume platform events and Change Data Capture events.

Usage tracking frequency: MonthlyPlatformEventsUsageEntitlement is updated once a day.

The entitlement is reset every month after your contract start date. Entitlement usage is computed only for production orgs. It is not available in sandbox or trial orgs. For more information, see Usage-based Entitlement Fields.

With an add-on license, you can exceed the maximum entitlement by a certain amount. As a result, the remaining value returned can be negative if you exceeded the maximum value.

Use MonthlyPlatformEventsUsageEntitlement with API version 48.0 or later to get an accurate event delivery usage based on the first day of your contract. In API version 47.0 and earlier, the MonthlyPlatformEvents value returns the usage based on the first of the month instead of the contract start date.
MonthlyPlatformEvents (API version 47.0 and earlier)

Org Without Add-On License: Daily Default Allocation

If your org doesn’t have the high-volume platform event or Change Data Capture add-on, use MonthlyPlatformEvents. This value contains the default allocation and usage for event delivery to CometD clients and is incremented for each client. This value doesn’t apply to non-CometD subscribers, such as Apex triggers, flows, and processes. To get the limit that is enforced daily, divide the monthly value returned by 30. MonthlyPlatformEvents includes usage for both high-volume platform events and Change Data Capture events.

Usage tracking frequency: MonthlyPlatformEvents is updated within a few minutes after event delivery.
Salesforce Connect
HourlyLongTermIdMapping Hourly new long-term external record ID mappings
HourlyODataCallout Hourly OData callouts
HourlyShortTermIdMapping Hourly new short-term external record ID mappings
Salesforce Developer Experience
ActiveScratchOrgs Daily and active scratch org counts
Storage
DataStorageMB Data storage (MB)

(The API user must have the Manage Users permission)
FileStorageMB File storage (MB)

(The API user must have the Manage Users permission)
Streaming API—Durable (API version 37.0 and later)
DailyDurableGenericStreamingApiEvents Generic events notifications delivered in the past 24 hours to all CometD clients
DailyDurableStreamingApiEvents PushTopic event notifications delivered in the past 24 hours to all CometD clients
DurableStreamingApiConcurrentClients Concurrent CometD clients (subscribers) across all channels and for all event types
Streaming API (API version 36.0 and earlier)
DailyGenericStreamingApiEvents Generic events notifications delivered in the past 24 hours to all CometD clients
DailyStreamingApiEvents PushTopic event notifications delivered in the past 24 hours to all CometD clients
StreamingApiConcurrentClients Concurrent CometD clients (subscribers) across all channels and for all event types
Workflows
DailyWorkflowEmails Daily workflow emails
HourlyTimeBasedWorkflow Hourly workflow time triggers
URI
/vXX.X/limits/
Formats
JSON, XML
HTTP Method
GET
Authentication
Authorization: Bearer token
Example
See List Organization Limits.