Introduction to REST API

REST API provides you with programmatic access to your data in Salesforce. The flexibility and scalability of REST API make it an excellent choice for integrating Salesforce into your applications and for performing complex operations on a large scale.

Use this guide to set up your deployment environment and learn about advanced details regarding data access. However, understanding and using REST API requires basic familiarity with software development, web services, and the Salesforce user interface.

If you want to get right to the action, the Quick Start guide covers the basics to get you up and running.

If you’re looking for more context about Salesforce APIs, check out the list of links.

Salesforce REST API is designed to work with Salesforce objects. See the Object Reference for the Salesforce Platform for an introduction and more information about Salesforce objects.

  • About REST API

    REST API is one of several web interfaces that you can use to access your Salesforce data without using the Salesforce user interface. With API access, you can perform operations and integrate Salesforce into your applications as you like.

  • REST API Release Notes

    Use the Salesforce Release Notes to learn about the most recent updates and changes to REST API.

  • Supported Editions and Required Permissions

    To access your Salesforce org and data using the Salesforce API, you need both an org and a user with API access enabled. There’s more than one Salesforce Edition that supports API access and multiple ways to grant API permission to a user.

  • REST Resources and Requests

    REST API is based on the usage of resources—pieces of data in Salesforce, such as records, collections of records, query results, metadata, or API information. Each resource is exposed by a uniform resource identifier (URI) and is accessed by sending HTTP requests to the corresponding URI.

  • REST API Architecture

    REST API follows the standard RESTful principles and characteristics.

  • Authorization Through External Client Apps or Connected Apps and OAuth 2.0

    For a client application to access REST API resources, it must be authorized as a safe visitor. To implement this authorization, use either an external client app or a connected app and an OAuth 2.0 authorization flow.

  • Headers

    REST API supports several standard and custom HTTP headers, including both request headers and response headers.

  • Send REST Requests with cURL

    The examples in this guide use the cURL tool to send HTTP requests that access, create, and manipulate resources in Salesforce. If you use a different tool to send requests, you can use the same elements from the cURL examples to send requests.

  • Valid Date and DateTime Formats

    Specify the right format for dateTime and date fields.

  • Status Codes and Error Responses

  • API End-of-Life Policy

    See which REST API versions are supported, unsupported, or unavailable.

See Also