{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"67cb9baa-e0da-4986-957e-88d8734647e2","name":"Salesforce Platform APIs","description":"The Salesforce Platform APIs collection contains 250+ requests and example responses for the following APIs:\n\n
Auth
Bulk (v1 & v2)
Composite
Connect
CPQ
Einstein Prediction Service
Event Platform
GraphQL
Loyalty Management
Metadata
REST
Subscription Management
Tooling
UI
\n\n**⚠️ Disclaimer:** this collection is not covered by Salesforce support and SLAs.\n\n## Get Started\n\nClick the button below and follow the instructions from the following sections: \n[\"Run](https://god.gw.postman.com/run-collection/12721794-67cb9baa-e0da-4986-957e-88d8734647e2?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D12721794-67cb9baa-e0da-4986-957e-88d8734647e2%26entityType%3Dcollection%26workspaceId%3D34382471-0c97-40e5-a206-f947271665c4)\n\n### New Salesforce Users\n\nIf you are new to Salesforce, start by obtaining a free [Developer Edition Org](https://developer.salesforce.com/signup) then, follow the rest of the instructions from this documentation.\n\nYou can also watch our [Beginner's Mind YouTube series](https://www.youtube.com/playlist?list=PLgIMQe2PKPSKJ33M6CX-VLvgax7Xptcmz) for a tour of the Salesforce Platform (the last episode focuses on APIs).\n\n### New Postman Users\n\n

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

\"\"

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

\"\"
\n\n### Regular Postman Users\n\nIf you are already familiar with Postman, here are the minimal getting started steps:\n\n1. If using Postman Web UI, follow these [steps to set up CORS](https://github.com/forcedotcom/postman-salesforce-apis/blob/master/install-with-web.md#enable-cors-in-salesforce) in your Salesforce Org. This is not required when working with the Postman Desktop app.\n \n2. Assign the following value to the `clientId` collection variable (this is a temporary step due to a Postman bug):\n\n```\n{{vault:salesforce-consumer-key}}\n```\n \n3. Assign a value to the `url` collection variable based on your Salesforce Org type:\n \n | URL | Org Type |\n | --- | --- |\n | `https://test.salesforce.com` | Sandboxes or Scratch orgs. |\n | `https://login.salesforce.com` | Production, Trailhead Playground and Developer Edition orgs. |\n | Custom My Domain base URL | Org with a custom domain. |\n \n4. Click **Get New Access Token** from the collection's **Authorization** tab.\n \n5. When prompted to do so, log in to your Salesforce org and allow access to \"Salesforce APIs Collection for Postman\".\n \n6. Copy the value of the `instance_url` field from the token details view.\n \n7. Click **Use Token**.\n \n8. Save the value that you copied in the `_endpoint` variable.\n \n9. Click **Save** and you're good to go!\n \n\n## Resources\n\nCheck out [the documentation](https://github.com/forcedotcom/postman-salesforce-apis) for videos and extra information on how to install, update and contribute to the collection.\n\nWe also have an [demo video](https://www.youtube.com/watch?v=W-IwW6RM4F0) on how to setup the collection.\n\n\n\nReport issues and ask questions [here](https://github.com/forcedotcom/postman-salesforce-apis/issues).\n\n## Variables Reference\n\nThe collection relies on the following variables:\n\n| Variable | Description |\n| --- | --- |\n| `_endpoint` | Your Salesforce Org's instance URL. |\n| `url` | The URL used for logging in. Either:
\\- `https://test.salesforce.com` for sandboxes or Scratch orgs
\\- `https://login.salesforce.com` for production, Trailhead Playground and Developer Edition orgs
\\- your custom My Domain base URL. |\n| `version` | The Salesforce API version (e.g.: 50.0). |\n| `username` | Your username. |\n| `password` | Your password. |\n| `secretToken` | Your personal [security token](https://help.salesforce.com/articleView?id=user_security_token.htm). |\n| `clientId` | Connected App client Id. |\n| `clientSecret` | Connected App client secret. |\n| `redirectUrl` | Connected App redirect URL for OAuth 2.0. |\n| `initAccessToken` | Initial access token for dynamic Connected App registration. |\n| `site` | Community suffix when connecting with an Experience Cloud user. |\n\nOnly 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`...).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"12721794","team":1292807,"collectionId":"67cb9baa-e0da-4986-957e-88d8734647e2","publishedId":"TVmFjfuh","public":true,"publicUrl":"https://documenter-api.postman.tech/view/12721794/TVmFjfuh","privateUrl":"https://go.postman.co/documentation/12721794-67cb9baa-e0da-4986-957e-88d8734647e2","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0070d2"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2021-01-20T17:11:38.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Salesforce Platform APIs Template Environment","id":"8b74caf1-3cbb-44d0-b245-855c0fb25f0d","owner":"12721794","values":[{"key":"url","value":"https://test.salesforce.com","enabled":true},{"key":"version","value":"57.0","enabled":true},{"key":"username","value":"","enabled":true},{"key":"password","value":"","enabled":true,"type":"secret"},{"key":"secretToken","value":"","enabled":true,"type":"secret"},{"key":"clientId","value":"","enabled":true},{"key":"clientSecret","value":"","enabled":true,"type":"secret"},{"key":"redirectUrl","value":"","enabled":true},{"key":"initAccessToken","value":"","enabled":true,"type":"secret"},{"key":"site","value":"","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/34624e13882b17764f2551a183282cf4b2478334e37c6c9994d96291d41a9c41","favicon":"https://res.cloudinary.com/postman/image/upload/v1602873857/team/unznzkzrjwtj7x2haem7.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Salesforce Platform APIs Template Environment","value":"12721794-8b74caf1-3cbb-44d0-b245-855c0fb25f0d"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/TVmFjfuh"}