The Salesforce REST API provides a simple and powerful web service interface to interact with Salesforce org data. It supports creating, reading, updating, deleting, and queryin...
The Salesforce SOAP API enables developers to use SOAP calls to create, retrieve, update, and delete records such as accounts, leads, and custom objects. It provides robust ente...
The Salesforce Bulk API is a specialized REST-based interface that enables asynchronous processing of large numbers of records. It is optimized for loading or deleting large set...
Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports C...
The Salesforce Streaming API uses a publish-subscribe model based on Bayeux/CometD to push near-real-time event notifications to subscribed clients. It supports PushTopic events...
The Salesforce Metadata API is a SOAP-based API that enables developers to retrieve, deploy, create, update, and delete customizations for Salesforce organizations. It is the fo...
The Salesforce Tooling API provides SOAP and REST interfaces for building developer tools for Force.com applications. It exposes fine-grained access to Apex code, Visualforce pa...
The Salesforce Connect REST API (formerly Chatter API) provides access to Salesforce Chatter feeds, groups, users, topics, and file sharing features. It also exposes Experience ...
The Salesforce Analytics REST API (also known as CRM Analytics or Wave API) provides programmatic access to CRM Analytics datasets, lenses, dashboards, and queries. Developers c...
The Salesforce Reports and Dashboards REST API enables developers to programmatically access report results, list reports and dashboards, and run and filter reports. It supports...
The Salesforce Einstein Platform Services API provides REST-based access to Salesforce AI capabilities including image classification, object detection, and sentiment analysis. ...
The Salesforce Einstein Prediction Service API enables programmatic access to Einstein Analytics predictions and forecasts built on CRM data. It allows applications to retrieve ...
The Salesforce GraphQL API provides a GraphQL interface to query and mutate Salesforce data. It allows clients to request exactly the data they need in a single request, reducin...
The Salesforce Pub/Sub API is a gRPC-based API for publishing and subscribing to platform events, change data capture events, and other event types in real time. It supersedes t...
Salesforce Platform Events enables event-driven integration architectures built on the Salesforce platform. Developers define custom event types as Salesforce objects and publis...
Salesforce Change Data Capture delivers change events that represent changes to Salesforce records including creates, updates, deletes, and undeletes. It enables external system...
The Salesforce UI API provides a comprehensive REST interface for building UIs that work with Salesforce metadata and data. It returns layout information, picklist values, list ...
The Salesforce Composite API allows developers to combine multiple Salesforce REST API requests into a single HTTP call. It reduces the number of round trips to the server and s...
Salesforce Apex REST enables developers to expose custom Apex classes as RESTful web services. By annotating Apex classes and methods with @RestResource and HTTP method annotati...
The Salesforce Data Cloud API provides programmatic access to Data Cloud (formerly Customer Data Platform) for ingesting, querying, and managing unified customer profiles. It en...
The Salesforce Marketing Cloud REST API provides access to Marketing Cloud resources including contacts, journeys, data extensions, triggered sends, and transactional messaging....
The Salesforce Marketing Cloud SOAP API is a full-featured SOAP web service interface for Marketing Cloud that supports subscriber management, email send operations, automation ...
The Salesforce Pardot API (now called Account Engagement API) provides programmatic access to Pardot marketing automation data including prospects, campaigns, forms, lists, and ...
The Salesforce Commerce Cloud Open Commerce API (OCAPI) provides a REST interface for accessing Salesforce B2C Commerce data and functionality including products, catalogs, orde...
The Salesforce Commerce Cloud Shopper APIs (SCAPI) are a modern set of REST APIs for building B2C Commerce storefronts and headless commerce experiences. They cover shopper auth...
The Salesforce Field Service API provides access to Field Service Lightning data and operations including work orders, service appointments, resource scheduling, and mobile work...
The Salesforce Health Cloud API provides FHIR R4-compliant REST APIs and platform APIs for accessing patient and provider data in Health Cloud. It enables healthcare application...
The Salesforce Financial Services Cloud API exposes financial services-specific data objects including financial accounts, assets, liabilities, financial goals, and household re...
The Salesforce Experience Cloud API provides REST access to Experience Cloud (formerly Community Cloud) data including community membership, navigation, managed content, and kno...
The MuleSoft Anypoint Platform API provides programmatic access to the MuleSoft integration platform including API Manager, Runtime Manager, Exchange, and Access Management. It ...
The Tableau REST API enables developers to programmatically manage Tableau Server and Tableau Cloud resources including workbooks, data sources, views, sites, users, and groups....
Lightning Web Components (LWC) is Salesforce's standards-based JavaScript framework for building UI components on the Salesforce platform. It uses modern web standards including...
Salesforce Aura Components is the legacy JavaScript component framework for building dynamic web applications on the Salesforce platform. It provides a data binding model, event...
The Salesforce Lightning Design System (SLDS) provides HTML and CSS component blueprints, design tokens, and utility classes for building applications visually consistent with S...
The Salesforce Agentforce Agent API is a REST API that enables developers to communicate with AI agents directly, starting sessions, sending messages, receiving responses, and e...
The Salesforce Models API provides Apex classes and REST endpoints that connect applications to large language models (LLMs) from Salesforce partners including Anthropic, Google...
The Salesforce Interaction Service API enables automation and customization of the Bring Your Own Channel (BYOC) experience for messaging. It sends inbound messaging interaction...
The Salesforce B2B Commerce API provides REST endpoints for handling commerce data in B2B and D2C storefronts. It offers support for address management, cart management, checkou...
The Salesforce Actions API provides a unified interface for invoking standard and custom actions across the Salesforce platform. It supports Apex actions, Flow actions, quick ac...
The Salesforce IoT REST API provides programmatic access to Salesforce IoT data including contexts, orchestrations, and usage data. It enables developers to manage IoT events an...
The Salesforce Service Cloud Voice API provides Telephony Integration REST API and Voice Toolkit API for programmatically managing voice calls and integrating telephony systems ...
The Salesforce Mobile SDK provides libraries and tools for building native and hybrid mobile applications on iOS and Android that integrate with the Salesforce platform. It supp...
Salesforce is a cloud-based customer relationship management (CRM) platform that helps organizations manage and grow customer relationships across the entire lifecycle. It unifi...
Run the full Bulk API 2.0 delete lifecycle — create a delete ingest job, upload a CSV of Ids, close, poll, and read successful results.
ARAZZO
Run the full Bulk API 2.0 insert lifecycle — create an ingest job, upload CSV, close, poll, and read successful results.
ARAZZO
Run the Bulk API 2.0 query lifecycle — create a query job, poll until JobComplete, and download the result CSV.
ARAZZO
Run the full Bulk API 2.0 upsert lifecycle — create an upsert ingest job keyed on an external Id field, upload CSV, close, poll, and read successful results.
ARAZZO
Create an Account and then create a Contact that belongs to it.
ARAZZO
Create a support Case associated with an existing Contact and Account.
ARAZZO
Create a Lead, then create the related Task and Campaign Member records that move it through the sales process.
ARAZZO
Create an Opportunity and then attach an OpportunityContactRole linking a Contact to the deal.
ARAZZO
Create an SObject record then retrieve it by its newly assigned record id.
ARAZZO
Delete an SObject record by id after confirming it exists.
ARAZZO
List all SObjects in the org then fully describe one object's metadata.
ARAZZO
Discover an object's list views, then load the records for a chosen list view.
ARAZZO
Read the current org governor limits and remaining quotas.
ARAZZO
Resolve an object's record type, then fetch its picklist field values.
ARAZZO
Fetch a record's UI API representation with its object metadata and layout fields.
ARAZZO
Authenticate, read a specific contact by its contact key, then delete it.
ARAZZO
Authenticate, upsert rows into a Data Extension, then read the rows back.
ARAZZO
Authenticate, find a published journey, inspect it, then fire an entry event.
ARAZZO
Authenticate, fire a triggered email send, then poll the recipient's send status.
ARAZZO
Run a SOQL query then page additional results via the queryMore token.
ARAZZO
Run a SOSL full-text search across multiple SObjects in a single call.
ARAZZO
Update fields on an existing SObject record then read it back to confirm.
ARAZZO
Create or update an SObject record keyed on an external id field value.
ARAZZO
Sales Cloud editions: Starter $25, Pro $65, Enterprise $175, Unlimited $350, Agentforce 1 $550 per user/mo
Service Cloud, Marketing Cloud, Commerce Cloud, Data Cloud, Tableau
REST API, SOAP API, Bulk API v1/v2, Streaming/CDC API, Composite API
Apex programming language and Lightning Web Components
AppExchange marketplace
Daily API calls: 100k Pro, 1M Enterprise, 5M Unlimited
Concurrent long-running API calls: 25 (75 on Performance/Unlimited)
Bulk API v1 batches: 15,000/day
Streaming events: 250k/day
Sandbox environments (Developer/Partial/Full)
Salesforce DX for source-driven development
Einstein Predictions and Generative AI (edition-gated)
Salesforce Data Cloud (CDP) with credit-based metering
Multi-org architecture for large enterprises
Industry Clouds (Financial, Health, Manufacturing, etc.)
Mulesoft for integration (separate licensing)
opencollection: 1.0.0
info:
name: Salesforce
version: '1.0'
request:
auth:
type: oauth2
flow: implicit
authorizationUrl: '{DefaultParameterValue}{DefaultParameterValue}/services/oauth2/authorize'
credentials:
clientId: '{{clientId}}'
items:
- info:
name: Initialize
type: folder
items:
- info:
name: Salesforce Registration - Initialize
type: http
http:
method: POST
url: https://login.salesforce.com/services/auth/headless/init/registration
body:
type: json
data: '{}'
docs: 'Submits the registration data to the init/registration endpoint and returns a request identifier. At the same time,
an OTP is sent out to the end users via email or sms. Registration data is passed in the request body, and is formatted
with JSON, with 5 keys: `userdata`, `customdata`, `password`, `recaptcha`, and `verificationmethod`. The first two keys
are JSON structures, and the last 3 keys are strings.
This request returns JSON, and includes an identifier (request identifier).'
- info:
name: Salesforce Forgot Password - Initialize
type: http
http:
method: POST
url: https://login.salesforce.com/services/auth/headless/forgot_password
body:
type: json
data: '{}'
docs: Salesforce Forgot Password - Initialize
- info:
name: Salesforce Passwordless Login - Initialize
type: http
http:
method: POST
url: https://login.salesforce.com/services/auth/headless/init/passwordless/login
body:
type: json
data: '{}'
docs: 'Submits the passwordless login data to the init/passwordless/login endpoint and returns a request identifier. At
the same time, an OTP is sent out to the end users via email or sms. Passwordless login data is passed in the request
body, and is formatted with JSON, with 3 keys: `username`, `recaptcha`, and `verificationmethod`. All 3 keys are strings.
This request returns JSON, and includes an identifier (request identifier).'
- info:
name: Agent
type: folder
items:
- info:
name: Salesforce User Agent Flow
type: http
http:
method: GET
url: https://login.salesforce.com/services/oauth2/authorize
params:
- name: response_type
value: example_value
type: query
- name: client_id
value: '500123'
type: query
- name: redirect_uri
value: example_value
type: query
- name: display
value: example_value
type: query
- name: login_hint
value: example_value
type: query
- name: nonce
value: example_value
type: query
docs: Salesforce User Agent Flow
- info:
name: Salesforce Run Agent Test
type: http
http:
method: POST
url: https://login.salesforce.com/data/v64.0/einstein/ai-evaluations/runs
body:
type: json
data: '{}'
docs: Generates a response based on the specified prompt template and input parameters ([documentation](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_prompt_template.htm)).
- info:
name: Authorize
type: folder
items:
- info:
name: Salesforce Registration - Authorize
type: http
http:
method: POST
url: https://login.salesforce.com/services/oauth2/authorize
headers:
- name: Auth-Request-Type
value: example_value
- name: Auth-Verification-Type
value: example_value
- name: Authorization
value: example_value
body:
type: form-urlencoded
data:
- name: response_type
value: ''
- name: client_id
value: ''
- name: redirect_uri
value: ''
- name: scope
value: ''
docs: 'After you send your registration data to initialize, this request allows you to process that registration data,
and as a part of this request you also verify the users email or sms number. The request itself is a authorization call
for the Code and Credential flow. It includes 3 specific headers: `Auth-Request-Type` which is set to `user-registration`,
`Auth-Verification-Type` which is set to email or sms, and an Authorization Basic header, which is the base 64 encoded
result of `identifier:otp`'
- info:
name: Exchange
type: folder
items:
- info:
name: Salesforce Registration - Token Exchange
type: http
http:
method: POST
url: https://login.salesforce.com/services/oauth2/token
body:
type: form-urlencoded
data:
- name: code
value: ''
- name: grant_type
value: ''
- name: client_id
value: ''
- name: redirect_uri
value: ''
docs: This exchanges the auth code returned in the Authorize Request for an access token and refresh token. This follows
the standard Auth Code flow/Webserver Code Flow pattern. The Code is the return form the Authorization call.
- info:
name: Get
type: folder
items:
- info:
name: Salesforce Get User Info
type: http
http:
method: GET
url: https://login.salesforce.com/services/oauth2/userinfo
headers:
- name: Authorization
value: example_value
- name: Content-Type
value: example_value
docs: This requests uses an access token to get user information from Salesforce using the standard `/userinfo` endpoint.
- info:
name: Salesforce Get Job Info Query
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/jobs/query/
docs: Salesforce Get Job Info Query
- info:
name: Salesforce Get Job Query Result
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/jobs/query//results
headers:
- name: Content-Type
value: example_value
- name: Accept
value: example_value
docs: Salesforce Get Job Query Result
- info:
name: Salesforce Get Parallel Results for a Query Job
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/jobs/query//resultPages
headers:
- name: Content-Type
value: example_value
- name: Accept
value: example_value
docs: Retrieves a set of up to 5 job results pages for parallel download.
- info:
name: Salesforce Get Job Info
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/jobs/ingest/
docs: Salesforce Get Job Info
- info:
name: Salesforce Get Job Successful Record Results
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/jobs/ingest//successfulResults
docs: Salesforce Get Job Successful Record Results
- info:
name: Salesforce Get Job Unprocessed Record Results
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/jobs/ingest//unprocessedrecords
docs: Salesforce Get Job Unprocessed Record Results
- info:
name: Salesforce Get Table
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/connect/business-rules/decision-table/definitions/:decisionTableId
params:
- name: decisionTableId
value: '500123'
type: path
description: Decision Table Id
docs: "# Decision Table Definitions ( GET)\n\nGet details of a decision table definition.\n\nResource\n\n```\n/connect/business-rules/decision-table/definitions/${decisionTableId}\n\
\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/decision-table/definitions/0lDxx00000002Ur\n\
\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nGET\n\nResponse body for GET\n\n[Decision\
\ Table Output](https://developer.salesforce.com/docs/atlas.en-us.industries_re"
- info:
name: Salesforce Get Test Status
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/einstein/ai-evaluations/runs/:runId
params:
- name: runId
value: '500123'
type: path
description: Evaluation ID
docs: Generates a response based on the specified prompt template and input parameters ([documentation](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_prompt_template.htm)).
- info:
name: Salesforce Get Test Results
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/einstein/ai-evaluations/runs/:runId/results
params:
- name: runId
value: '500123'
type: path
description: Evaluation ID
docs: Generates a response based on the specified prompt template and input parameters ([documentation](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_prompt_template.htm)).
- info:
name: Salesforce Integration Procedure Invocation Using Get
type: http
http:
method: GET
url: https://login.salesforce.com/apexrest/:NAMESPACE/v1/integrationprocedure/:TYPE_SUBTYPE
params:
- name: NAMESPACE
value: example_value
type: path
description: 'The namespace: `omnistudio`, `vlocity_ins`, `vlocity_cmt`, or `vlocity_ps`'
- name: TYPE_SUBTYPE
value: example_value
type: path
description: Type and SubType of the Integration Procedure separated by an underscore.
docs: Salesforce Integration Procedure Invocation Using Get
- info:
name: Salesforce Sobject Get Deleted
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/deleted
headers:
- name: Content-Type
value: example_value
params:
- name: start
value: example_value
type: query
- name: end
value: example_value
type: query
- name: SOBJECT_API_NAME
value: example_value
type: path
docs: 'Retrieves the list of individual records that have been deleted within the given timespan for the specified object.
SObject Get Deleted is available in API version 29.0 and later.
This resource is commonly used in data replication applications. Note the following considerations:
Deleted records are written to a delete log which this resource accesses. A background process that runs every two hours
purges records that have been in an organization''s delete log for more than two hours if the numbe'
- info:
name: Salesforce Sobject Get Updated
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/updated
headers:
- name: Content-Type
value: example_value
params:
- name: start
value: example_value
type: query
- name: end
value: example_value
type: query
- name: SOBJECT_API_NAME
value: example_value
type: path
docs: 'Retrieves the list of individual records that have been updated (added or changed) within the given timespan for
the specified object. SObject Get Updated is available in API version 29.0 and later.
This resource is commonly used in data replication applications. Note the following considerations:
Results are returned for no more than 30 days previous to the day the call is executed.
Your client application can replicate any objects to which it has sufficient permissions. For example, to replic'
- info:
name: Salesforce Get List Views for an Object
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/ui-api/list-info/:SOBJECT_API_NAME
params:
- name: SOBJECT_API_NAME
value: example_value
type: path
description: API name of a UI API supported object.
docs: Get list views associated with an object.
- info:
name: Salesforce Get List View Records by Id
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/ui-api/list-records/:LIST_VIEW_ID
params:
- name: LIST_VIEW_ID
value: '500123'
type: path
description: The ID of a list view.
docs: Get record data for a list view by list view ID using URL parameters.
- info:
name: Salesforce Get List View Records by Api Name
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/ui-api/list-records/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME
params:
- name: SOBJECT_API_NAME
value: example_value
type: path
description: API name of a UI API supported object.
- name: LIST_VIEW_API_NAME
value: example_value
type: path
description: API name of a list view, such as AllAccounts, __Recent, or __SearchResult.
docs: Get record data for a list view by list view API name using URL parameters.
- info:
name: Salesforce Get List View Records
type: http
http:
method: POST
url: https://login.salesforce.com/data/v64.0/ui-api/list-records/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME
params:
- name: SOBJECT_API_NAME
value: example_value
type: path
description: API name of the UI API supported object.
- name: LIST_VIEW_API_NAME
value: example_value
type: path
description: API name of a list view.
body:
type: json
data: '{}'
docs: Get record data for a list view using a request body.
- info:
name: Salesforce Get List View Metadata by Id
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/ui-api/list-info/:LIST_VIEW_ID
params:
- name: LIST_VIEW_ID
value: '500123'
type: path
description: The ID of a list view.
docs: Get list view metadata by list view ID using URL parameters.
- info:
name: Salesforce Get List View Metadata by Api Name
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/ui-api/list-info/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME
params:
- name: SOBJECT_API_NAME
value: example_value
type: path
description: API name of the UI API supported object.
- name: LIST_VIEW_API_NAME
value: example_value
type: path
description: API name of a list view, such as AllAccounts, __Recent, or __SearchResult.
docs: Get list view metadata by list view API name using URL parameters.
- info:
name: Salesforce Get Sandbox
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID
params:
- name: SANDBOX_INFO_ID
value: '500123'
type: path
docs: Retrieves a sandbox record.
- info:
name: Salesforce Get Tooling Metadata Sobject
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/tooling/sobjects/:SOBJECT_API_NAME
params:
- name: SOBJECT_API_NAME
value: example_value
type: path
docs: Salesforce Get Tooling Metadata Sobject
- info:
name: Salesforce Get Record Layout Metadata
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/ui-api/layout/:SOBJECT_API_NAME
params:
- name: SOBJECT_API_NAME
value: example_value
type: path
docs: Get metadata about page layouts for the specified object type.
- info:
name: Salesforce Get Object Metadata
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/ui-api/object-info/:SOBJECT_API_NAME
params:
- name: SOBJECT_API_NAME
value: example_value
type: path
docs: Get metadata about a specific object. The response includes metadata describing fields, child relationships, record
type, and theme.
- info:
name: Salesforce Get a Record
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/ui-api/records/:RECORD_ID
params:
- name: RECORD_ID
value: '500123'
type: path
docs: Get a record’s data.
- info:
name: Salesforce Get Favorites
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/ui-api/favorites
docs: Get all of a user’s favorites.
- info:
name: Salesforce Get Personalized Navigation Items
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/ui-api/apps/:APP_ID/user-nav-items
params:
- name: APP_ID
value: '500123'
type: path
description: Application ID
docs: Get a user’s personalized navigation items (tabs).
- info:
name: Revoke
type: folder
items:
- info:
name: Salesforce Revoke Token
type: http
http:
method: POST
url: https://login.salesforce.com/services/oauth2/revoke
body:
type: form-urlencoded
data:
- name: token
value: ''
docs: 'This calls the standard revoke endpoint, passing in your access token. This endpoint should be called as part of
your logout process to invalidate the access and refresh token. '
- info:
name: Oauth
type: folder
items:
- info:
name: Salesforce Oauth Usage
type: http
http:
method: GET
url: https://login.salesforce.com/services/data/v64.0/apps/oauth/usage
headers:
- name: Authorization
value: example_value
params:
- name: page
value: '10'
type: query
description: Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0,
the first page is returned.
- name: pageSize
value: '10'
type: query
description: Number of usage entries per page. Defaults to 100.
docs: Lists all the external client apps for the current org. See [OAuth Usage](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage.htm).
- info:
name: Salesforce Oauth User Tokens Revoke
type: http
http:
method: DELETE
url: https://login.salesforce.com/services/data/v64.0/apps/oauth/usage///tokens
headers:
- name: Authorization
value: example_value
docs: Revokes all tokens for a user of the external client app. See [Refresh Token by User and App](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_app_id_user_id_tokens.htm).
- info:
name: Salesforce Oauth Tokens Revoke
type: http
http:
method: DELETE
url: https://login.salesforce.com/services/data/v64.0/apps/oauth/usage//tokens
headers:
- name: Authorization
value: example_value
docs: Revokes all tokens available for the external client app. See [Refresh Token by App ID](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_app_id_tokens.htm).
- info:
name: Salesforce Oauth Token Revoke
type: http
http:
method: DELETE
url: https://login.salesforce.com/services/data/v64.0/apps/oauth/usage/tokens/
headers:
- name: Authorization
value: example_value
docs: Revokes one token. See [OAuth Refresh Token](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_tokens_token_id.htm).
- info:
name: Applications
type: folder
items:
- info:
name: Salesforce Oauth App Users
type: http
http:
method: GET
url: https://login.salesforce.com/services/data/v64.0/apps/oauth/usage//users
headers:
- name: Authorization
value: example_value
params:
- name: page
value: '10'
type: query
description: Page number for the usage information. Defaults to 0.
- name: pageSize
value: '10'
type: query
description: Number of usage entries per page. Defaults to 100.
docs: Lists all users for the external client app indicated by the app ID. See [OAuth Users by App ID](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_app_id_users.htm).
- info:
name: Salesforce Oauth App Users Tokens
type: http
http:
method: GET
url: https://login.salesforce.com/services/data/v64.0/apps/oauth/usage///tokens
headers:
- name: Authorization
value: example_value
docs: Lists all tokens for a user of the external client app. See [Refresh Token by User and App](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_app_id_user_id_tokens.htm).
- info:
name: Salesforce Lightning Usage by App Type
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/sobjects/LightningUsageByAppTypeMetrics
headers:
- name: Content-Type
value: example_value
docs: 'Return the total number of Lightning Experience and Salesforce Mobile users.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebyapptypemetrics.htm'
- info:
name: Salesforce Get Apps
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/ui-api/apps
params:
- name: formFactor
value: example_value
type: query
description: The form factor for each app that the user has access to (`Large`, `Medium` or `Small`)
docs: Get metadata for all the apps a user has access to. Metadata for the selected app includes tabs on the app’s navigation
bar. Metadata for other apps doesn’t include tabs on the navigation bar.
- info:
name: Salesforce Get an App
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/ui-api/apps/:APP_ID
params:
- name: formFactor
value: example_value
type: query
description: The form factor for each app that the user has access to (`Large`, `Medium` or `Small`)
- name: APP_ID
value: '500123'
type: path
description: Application ID
docs: Get metadata about an app.
- info:
name: Salesforce Update Last Selected App
type: http
http:
method: PATCH
url: https://login.salesforce.com/data/v64.0/ui-api/apps/:APP_ID
params:
- name: formFactor
value: example_value
type: query
description: The form factor for each app that the user has access to (`Large`, `Medium` or `Small`)
- name: APP_ID
value: '500123'
type: path
description: Application ID
docs: Returns metadata for an app, and saves an app as the last selected for a user.
- info:
name: Salesforce Get Last Selected App
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/ui-api/apps/selected
params:
- name: formFactor
value: example_value
type: query
description: The form factor for each app that the user has access to (`Large`, `Medium` or `Small`)
docs: Retrieves the app the current user last selected or the app the user sees by default.
- info:
name: Collections
type: folder
items:
- info:
name: Salesforce Collections
type: http
http:
method: GET
url: https://login.salesforce.com/services/data/v64.0/apps/oauth/credentials/
headers:
- name: Authorization
value: example_value
docs: Returns credentials for all consumers associated with an external client app. See [OAuth Credentials by App ID](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_credentials_by_app_id.htm).
- info:
name: Salesforce Sobject Collections Create
type: http
http:
method: POST
url: https://login.salesforce.com/data/v64.0/composite/sobjects
body:
type: json
data: '{}'
docs: 'Executes actions on multiple records in one request. Use SObject Collections to reduce the number of round-trips
between the client and server. This resource is available in API version 42.0 and later.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections.htm'
- info:
name: Salesforce Sobject Collections Update
type: http
http:
method: PATCH
url: https://login.salesforce.com/data/v64.0/composite/sobjects
body:
type: json
data: '{}'
docs: 'Executes actions on multiple records in one request. Use SObject Collections to reduce the number of round-trips
between the client and server. This resource is available in API version 42.0 and later.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections.htm'
- info:
name: Salesforce Sobject Collections Delete
type: http
http:
method: DELETE
url: https://login.salesforce.com/data/v64.0/composite/sobjects
headers:
- name: Content-Type
value: example_value
params:
- name: ids
value: example_value
type: query
- name: allOrNone
value: 'true'
type: query
docs: 'Executes actions on multiple records in one request. Use SObject Collections to reduce the number of round-trips
between the client and server. This resource is available in API version 42.0 and later.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections.htm'
- info:
name: Salesforce Sobject Collections Retrieve
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0/composite/sobjects/:SOBJECT_API_NAME
headers:
- name: Content-Type
value: example_value
params:
- name: ids
value: example_value
type: query
- name: fields
value: example_value
type: query
- name: SOBJECT_API_NAME
value: example_value
type: path
docs: 'Executes actions on multiple records in one request. Use SObject Collections to reduce the number of round-trips
between the client and server. This resource is available in API version 42.0 and later.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections.htm'
- info:
name: Salesforce Sobject Collections Upsert
type: http
http:
method: PATCH
url: https://login.salesforce.com/data/v64.0/composite/sobjects/:SOBJECT_API_NAME/:FIELD_NAME
params:
- name: SOBJECT_API_NAME
value: example_value
type: path
- name: FIELD_NAME
value: example_value
type: path
body:
type: json
data: '{}'
docs: 'Use a PATCH request with sObject Collections to either create or update (upsert) up to 200 records based on an
external ID field. This method returns a list of UpsertResult objects. You can choose whether to roll back the entire
request when an error occurs. This request is available in API version 46 and later.
[https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_upsert.htm](https://developer.salesforce.com/docs/atlas.en-us.api_rest'
- info:
name: Resources
type: folder
items:
- info:
name: Salesforce Resources
type: http
http:
method: GET
url: https://login.salesforce.com/services/data/v64.0/apps/oauth/credentials//
headers:
- name: Authorization
value: example_value
params:
- name: part
value: example_value
type: query
description: Key, Secret, or KeyAndSecret
docs: Returns credentials for a specific consumer. Use parameters to determine whether the request should return the key,
the secret, or both key and secret. See [OAuth Credentials by Consumer ID](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_credentials_by_app_and_consumer_id.htm).
- info:
name: Salesforce Resources by Version
type: http
http:
method: GET
url: https://login.salesforce.com/data/v64.0
headers:
- name: Content-Type
value: example_value
docs: Lists available resources for the specified API version, including resource name and URI.
- info:
name: Connect
type: folder
items:
- info:
name: Salesforce Openid Connect Discovery Endpoint
type: http
http:
method: GET
url: https://login.salesforce.com/.well-known/openid-configuration
docs: Salesforce Openid Connect Discovery Endpoint
- info:
name: Salesforce Openid Connect Token Introspection Endpoint
type: http
http:
method: POST
url: https://login.salesforce.com/services/oauth2/introspect
headers:
- name: Content-Type
value: example_value
- name: Accept
value: example_value
body:
type: form-urlencoded
data:
- name: token
value: ''
- name: token_type_hint
value: ''
- name: client_id
value: ''
- name: client_secret
value: ''
docs: Salesforce Openid Connect Token Introspection Endpoint
- info:
name: Authentication
type: folder
items:
- info:
name: Salesforce Authentication Configuration Endpoint
type: http
http:
method: GET
url: https://login.salesforce.com/.well-known/auth-configuration
docs: Salesforce Authentication Configuration Endpoint
- info:
name: Client
type: folder
items:
- info:
name: Salesforce Openid Connect Dynamic Client Registration Endpoint
type: http
http:
method: POST
url: https://login.salesforce.com/services/oauth2/register
headers:
- name: Accept
value: example_value
- name: Authorization
value: example_value
body:
type: json
data: '{}'
docs: Salesforce Openid Connect Dynamic Client Registration Endpoint
- info:
name: Keys
type: folder
items:
- info:
name: Salesforce Keys
type: http
http:
method: GET
url: https://login.salesforce.com/id/keys
docs: Salesforce Keys
- info:
name: Identifiers
type: folder
items:
- info:
name: Salesforce Id Token
type: http
http:
method: GET
url: https://login.salesforce.com//
headers:
- name: Content-Type
value: example_value
docs: Salesforce Id Token
- info:
name: Abort
type: folder
items:
- info:
name: Salesforce Abort a Job Query
type: http
http:
method: PATCH
url: https://login.salesforce.com/data/v64.0/jobs/query/
body:
type: json
data: '{}'
docs: Salesforce Abort a Job Query
- info:
name: Salesforce Close or Abort a Job
type: http
http:
method: PATCH
url: https://login.salesforce.com/data/v64.0/jobs/ingest/
body:
type: json
data: '{}'
docs: Salesforce Close or Abort a Job
- info:
name: Deletes
type: folder
items:
- info:
name: Salesforce Delete Job Query
type: http
http:
method: DELETE
url: https://login.salesforce.com/data/v64.0/jobs/query/
docs: Salesforce Delete Job Query
- info:
name: Salesforce Delete Job
type: http
http:
method: DELETE
url: https://login.salesforce.com/data/v64.0/jobs/ingest/
docs: Salesforce Delete Job
- info:
name: Salesforce File Information - Delete
type: http
http:
method: DELETE
url: https://login.salesforce.com/data/v64.0/connect/files/:FILE_ID
params:
- name: FILE_ID
value: '500123'
type: path
docs: 'Get information about a specified file, including references to external files. Upload a new version of an existing
# --- truncated at 32 KB (183 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/apis.yml