Salesforce Platform APIs

Number of APIs: 664

The Salesforce Platform APIs collection contains 250+ requests and example responses for the following APIs:

⚠️ Disclaimer: this collection is not covered by Salesforce support and SLAs.

Get Started

Click the button below and follow the instructions from the following sections:
[]

New Salesforce Users

If you are new to Salesforce, start by obtaining a free Developer Edition Org then, follow the rest of the instructions from this documentation.

You can also watch our Beginner's Mind YouTube series for a tour of the Salesforce Platform (the last episode focuses on APIs).

New Qodex Users

If you are new to Qodex, complete this Trailhead project to setup the collection: Quick Start: Connect Qodex to Salesforce.

If you want to learn more about Qodex in general, you can also complete this optional Trailhead badge: Qodex API Client.

Regular Qodex Users

If you are already familiar with Qodex, here are the minimal getting started steps:

1. If using Qodex Web UI, follow these steps to set up CORS in your Salesforce Org. This is not required when working with the Qodex Desktop app.

2. Assign a value to the url collection variable based on your Salesforce Org type:

   URL	Org Type
   https://test.salesforce.com	Sandboxes or Scratch orgs.
   https://login.salesforce.com	Production, Trailhead Playground and Developer Edition orgs.
   Custom My Domain base URL	Org with a custom domain.

3. Click Get New Access Token from the collection's Authorization tab.

4. When prompted to do so, log in to your Salesforce org and allow access to Salesforce APIs Collection for Qodex.

5. Copy the value of the instance_url field from the token details view.

6. Click Use Token.

7. Save the value that you copied in the _endpoint variable.

8. Click Save and you're good to go!

Resources

Check out the documentation for videos and extra information on how to install, update and contribute to the collection.

We also have an demo video on how to setup the collection.

Report issues and ask questions here.

Variables Reference

The collection relies on the following variables:

Only a few of these variables are mandatory. The authentication requests will automatically register and set extra private variables identified with a _ prefix (e.g.: _accessToken, _orgId, _userId...).

1. Connect-Chatter-Feeds - User Profile Feed Elements GET {{_endpoint}}/services/data/v{{version}}/chatter/feeds/user-profile/:USER_ID/feed-elements

2. UI-Actions - Get Lightning Page Actions GET {{_endpoint}}/services/data/v{{version}}/ui-api/actions/flexipage/:FLEXIPAGE_NAMES

3. Connect-Chatter-Feeds - User Profile Feed Elements GET {{_endpoint}}/services/data/v{{version}}/chatter/feeds/user-profile/:USER_ID/feed-elements

4. UI-Actions - Get Lookup Field Actions GET {{_endpoint}}/services/data/v{{version}}/ui-api/actions/lookup/:SOBJECT_API_NAMES

5. Connect-Chatter-Feed Elements - Feed Elements, Batch Post POST {{_endpoint}}/services/data/v{{version}}/chatter/feed-elements/batch

6. REST-Search - Search Suggested Queries GET {{_endpoint}}/services/data/v{{version}}/search/suggestSearchQueries?q&language

7. Connect-Chatter-Feed Elements - Feed Elements, Post and Search POST {{_endpoint}}/services/data/v{{version}}/chatter/feed-elements?feedElementType=FeedItem&subjectId=<USER_GROUP_RECORD_ID>&text=New Feed Item

8. Auth-Headless Identity API Demo - Registration - Initialize POST {{url}}{{site}}/services/auth/headless/init/registration

9. Auth-External Client Apps-OAuth Usage - OAuth Usage GET {{url}}{{site}}/services/data/v{{version}}/apps/oauth/usage?page=0&pageSize=100

10. Auth-Headless Identity API Demo - Forgot Password - Change Password POST {{url}}{{site}}/services/auth/headless/forgot_password