Force.com REST API Developer's Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Newer Version Available
Reference
The following table lists supported REST resources in the API and provides a brief description for each. In each case, the URI for the resource follows the base URI, which you retrieve from the authentication service: http://domain/services/data. domain might be the Salesforce instance you are using, or a custom domain. For example, to retrieve basic information about an Account object in version 20.0: http://na1.salesforce.com/services/data/v20.0/sobjects/Account/.
Click a call name to see syntax, usage, and more information for that call.
| Resource Name | URI | Description |
|---|---|---|
| Versions | / | Lists summary information about each Salesforce version currently available, including the version, label, and a link to each version's root. |
| Resources by Version | /vXX.X/ | Lists available resources for the specified API version, including resource name and URI. |
| Limits | /vXX.X/limits/ | Lists information about limits in your organization. |
| Describe Global | /vXX.X/sobjects/ | Lists the available objects and their metadata for your organization's data. |
| SObject Basic Information | /vXX.X/sobjects/SObject/ | Describes the individual metadata for the specified object. Can also be used to create a new record for a given object. |
| SObject Describe | /vXX.X/sobjects/SObject/describe/ | Completely describes the individual metadata at all levels for the specified object. |
| SObject Get Deleted | /vXX.X/sobjects/SObject/deleted/?start=startDateAndTime&end=endDateAndTime | Retrieves the list of individual records that have been deleted within the given timespan for the specified object. |
| SObject Get Updated | /vXX.X/sobjects/SObject/updated/?start=startDateAndTime&end=endDateAndTime | Retrieves the list of individual records that have been updated (added or changed) within the given timespan for the specified object. |
| SObject Named Layouts | /vXX.X/sobjects/Object/describe/namedLayouts/layoutName | Retrieves information about alternate named layouts for a given object. |
| SObject Rows | /vXX.X/sobjects/SObject/id/ | Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. |
| SObject Rows by External ID | /vXX.X/sobjects/SObject/fieldName/fieldValue | Creates new records or updates existing records (upserts records) based on the value of a specified external ID field. |
| SObject ApprovalLayouts | /vXX.X/sobjects/SObjectName/describe/approvalLayouts/ | Returns a list of approval layouts for a specified object. |
| SObject CompactLayouts | /vXX.X/sobjects/Object/describe/compactLayouts/ | Returns a list of compact layouts for a specific object. |
| SObject Layouts | /vXX.X/sobjects/global/describe/layouts/ /vXX.X/sobjects/object/describe/layouts/ |
Returns a list of layouts and descriptions, including for actions. |
| SObject PlatformAction | /services/data/vXX.X/sobjects/PlatformAction | PlatformAction is a virtual read-only object that enables you to query for actions—such as standard and custom buttons, quick actions, and productivity actions—that should be displayed in a UI, given a user, a context, device format, and a record ID. |
| SObject Blob Retrieve | /vXX.X/sobjects/SObject/id/blobField | Retrieves the specified blob field from an individual record. |
| SObject Quick Actions | /vXX.X/sobjects/object/quickActions/ /vXX.X/sobjects/object/quickActions/{action name} /vXX.X/sobjects/object/quickActions/{action name}/describe/ services/data/vXX.X/sobjects/object/quickActions/{action name}/defaultValues/ vXX.X/sobjects/object/quickActions/{action name}/defaultValues/{parent id} |
Returns a list of actions and their details. |
| SObject Suggested Articles for Case | vXX.X/sobjects/Case/suggestedArticles?language=article language&subject=case
subject&description=case description vXX.X/sobjects/Case/ID/suggestedArticles?language=article language |
Returns a list of suggested Salesforce Knowledge articles for a case. |
| SObject User Password | /vXX.X/sobjects/User/user
id/password /vXX.X/sobjects/SelfServiceUser/self service user id/password |
Set, reset, or get information about a user password. |
| AppMenu | /vXX.X/appMenu/AppSwitcher/ /vXX.X/appMenu/Salesforce1/ |
Returns a list of items in either the Salesforce app drop-down menu or the Salesforce1 navigation menu. |
| Compact Layouts | /vXX.X/compactLayouts?q=object list | Returns a list of compact layouts for multiple objects. |
| FlexiPage | /vXX.X/flexiPage/ID of Lightning Page | Returns a list of Lightning Pages and their details. Information returned includes Lightning Page regions, the components within each region, and each component’s properties, as well as any associated QuickActions. |
| Process Approvals | /vXX.X/process/approvals/ | Returns a list of all approval processes. Can also be used to submit a particular record if that entity supports an approval process and one has already been defined. Records can be approved and rejected if the current user is an assigned approver. |
| Process Rules | /vXX.X/process/rules/ | Returns a list of all active workflow rules. If a rule has actions, the actions will be listed under the rule. Can also be used to trigger all workflow rules that are associated with a specified record. The actions for a rule are only fired if the rule’s criteria is met. |
| Query | /vXX.X/query/?q=soql | Executes the specified SOQL query. |
| QueryAll | /vXX.X/queryAll/?q=soql | Executes the specified SOQL query. Results can include deleted, merged and archived records. |
| Quick Actions | /vXX.X/quickActions/ | Return a list of global quick actions and their types, as well as custom fields and objects that appear in the Chatter feed. |
| Search | /vXX.X/search/?s=sosl | Executes the specified SOSL search. The search string must be URL-encoded. |
| Search Scope and Order | /vXX.X/search/scopeOrder | Returns an ordered list of objects in the default global search scope of a logged-in user. Global search keeps track of which objects the user interacts with and how often and arranges the search results accordingly. Objects used most frequently appear at the top of the list. |
| Search Result Layouts | /vXX.X/searchlayout/?q=Comma delimited object list | Returns search result layout information for the objects in the query string. For each object, this call returns the list of fields displayed on the search results page as columns, the number of rows displayed on the first page, and the label used on the search results page. |
| Recently Viewed Items | /vXX.X/recent | Gets the most recently accessed items that were viewed or referenced by the current user. |
| Search Suggested Article Title Matches | vXX.X/search/suggestTitleMatches?q=search string&language=article language&publishStatus=article publication status | Returns a list of Salesforce Knowledge articles whose titles match the user’s search query string. Provides a shortcut to navigate directly to likely relevant articles, before the user performs a search. |
| Search Suggested Queries | vXX.X/search/suggestSearchQueries?q=search string&language=language of query | Returns a list of suggested searches based on the user’s query string text matching searches that other users have performed in Salesforce Knowledge. Provides a way to improve search effectiveness, before the user performs a search. |
| Tabs | /vXX.X/tabs | Returns a list of all tabs—including Lightning Page tabs—available to the current user, regardless of whether the user has chosen to hide tabs via the All Tabs (+) tab customization feature. |
| Themes | /vXX.X/theme | Gets the list of icons and colors used by themes in the Salesforce application. |