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
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. 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:
  • Daily API calls
  • Daily asynchronous Apex method executions (batch Apex, future methods, queueable Apex, and scheduled Apex)
  • Daily Bulk API calls
  • Daily Streaming API events (API version 36.0 and earlier)
  • Daily durable Streaming API events (API version 37.0 and later)
  • Streaming API concurrent clients (API version 36.0 and earlier)
  • Durable Streaming API concurrent clients (API version 37.0 and later)
  • Daily generic streaming events (API version 36.0 and earlier)
  • Daily durable generic streaming events (API version 37.0 and later)
  • Daily standard-volume platform events delivered to CometD clients
  • Monthly entitlement and usage of high-volume platform event delivery to CometD clients
  • Daily number of mass emails that are sent to external email addresses by using Apex or APIs
  • 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

  • Concurrent REST API requests for results of asynchronous report runs
  • Concurrent synchronous report runs via REST API
  • Hourly asynchronous report runs via REST API
  • Hourly synchronous report runs via REST API
  • Hourly dashboard refreshes via REST API
  • Hourly REST API requests for dashboard results
  • Hourly dashboard status requests via REST API
  • Hourly new long-term external record ID mappings (API version 44.0 and later)
  • Hourly OData callouts
  • Hourly new short-term external record ID mappings (API version 44.0 and later)
  • Daily workflow emails
  • Hourly workflow time triggers
  • Daily and active scratch org counts

The resource also returns these limits if the API user has the Manage Users permission.

  • Data storage (MB)
  • File storage (MB)
URI
/vXX.X/limits/
Formats
JSON, XML
HTTP Method
GET
Authentication
Authorization: Bearer token
Example
See List Organization Limits.