openapi: 3.1.0
info:
title: Salesforce Bulk API 2.0 Abort Applications API
description: '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 CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.
'
version: v63.0
contact:
name: Salesforce Developers
url: https://developer.salesforce.com/
license:
name: Salesforce Developer Terms
url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
description: Salesforce Bulk API 2.0 jobs endpoint
variables:
instance:
default: yourInstance
description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).
'
version:
default: '63.0'
description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.
'
security:
- BearerAuth: []
tags:
- name: Applications
paths:
/services/data/v64.0/apps/oauth/usage//users:
parameters: []
get:
tags:
- Applications
summary: Salesforce Oauth App Users
description: 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).
operationId: OAuthAppUsers
parameters:
- name: page
in: query
description: Page number for the usage information. Defaults to 0.
required: true
style: form
explode: true
schema:
type: integer
contentEncoding: int32
examples:
- 0
example: 10
- name: pageSize
in: query
description: Number of usage entries per page. Defaults to 100.
required: true
style: form
explode: true
schema:
type: integer
contentEncoding: int32
examples:
- 100
example: 10
- name: Authorization
in: header
description: Replace <token> with your access token
required: true
schema:
type: string
examples:
- Bearer <token>
example: example_value
responses:
default:
description: ''
headers: {}
content:
text/plain:
schema:
type: string
examples:
- "{\n \"currentPageUrl\": \"/services/data/<version>/apps/oauth/usage/<identifier>/users?page=0&pageSize=100\",\n \"nextPageUrl\": \"/services/data/<version>/apps/oauth/usage/<identifier>/users?page=1&pageSize=100\",\n \"users\": [\n {\n \"accessTokenFormat\": \"<accessTokenFormat>\",\n \"appDeveloperName\": \"<appDeveloperName>\",\n \"appIdentifier\": \"<identifier>\",\n \"initialConnectionAt\": \"<timestamp>\",\n \"lastUsedAt\": \"<timestamp>\",\n \"revocationUrl\": \"/services/data/<version>/apps/oauth/usage/<identifier>/<userIdentifier>/tokens\",\n \"useCount\": integer,\n \"userIdentifier\": \"<userIdentifier>\",\n \"username\": \"<username>\"\n }\n ]\n}"
contentMediaType: text/plain
example: "{\n \"currentPageUrl\": \"/services/data/<version>/apps/oauth/usage/<identifier>/users?page=0&pageSize=100\",\n \"nextPageUrl\": \"/services/data/<version>/apps/oauth/usage/<identifier>/users?page=1&pageSize=100\",\n \"users\": [\n {\n \"accessTokenFormat\": \"<accessTokenFormat>\",\n \"appDeveloperName\": \"<appDeveloperName>\",\n \"appIdentifier\": \"<identifier>\",\n \"initialConnectionAt\": \"<timestamp>\",\n \"lastUsedAt\": \"<timestamp>\",\n \"revocationUrl\": \"/services/data/<version>/apps/oauth/usage/<identifier>/<userIdentifier>/tokens\",\n \"useCount\": integer,\n \"userIdentifier\": \"<userIdentifier>\",\n \"username\": \"<username>\"\n }\n ]\n}"
deprecated: false
security: []
servers:
- url: https://login.salesforce.com
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/services/data/v64.0/apps/oauth/usage///tokens:
parameters: []
get:
tags:
- Applications
summary: Salesforce Oauth App Users Tokens
description: 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).
operationId: OAuthAppUsersTokens
parameters:
- name: Authorization
in: header
description: Replace <token> with your access token
required: true
schema:
type: string
examples:
- Bearer <token>
example: example_value
responses:
default:
description: ''
headers: {}
content:
text/plain:
schema:
type: string
examples:
- "{\n \"currentPageUrl\": \"/services/data/<version>/apps/oauth/usage/<identifier>/<userIdentifier>/tokens\",\n \"tokens\": [\n {\n \"accessTokenFormat\": \"<accessTokenFormat>\",\n \"appDeveloperName\": \"<appDeveloperName>\",\n \"appIdentifier\": \"<identifier>\",\n \"initialConnectionAt\": \"<timestamp>\",\n \"lastUsedAt\": \"<timestamp>\",\n \"revocationUrl\": \"/services/data/<version>/apps/oauth/usage/tokens/<tokenIdentifier>\",\n \"useCount\": integer,\n \"userIdentifier\": \"<userIdentifier>\",\n \"username\": \"<username>\"\n }\n ]\n}"
contentMediaType: text/plain
example: "{\n \"currentPageUrl\": \"/services/data/<version>/apps/oauth/usage/<identifier>/<userIdentifier>/tokens\",\n \"tokens\": [\n {\n \"accessTokenFormat\": \"<accessTokenFormat>\",\n \"appDeveloperName\": \"<appDeveloperName>\",\n \"appIdentifier\": \"<identifier>\",\n \"initialConnectionAt\": \"<timestamp>\",\n \"lastUsedAt\": \"<timestamp>\",\n \"revocationUrl\": \"/services/data/<version>/apps/oauth/usage/tokens/<tokenIdentifier>\",\n \"useCount\": integer,\n \"userIdentifier\": \"<userIdentifier>\",\n \"username\": \"<username>\"\n }\n ]\n}"
deprecated: false
security: []
servers:
- url: https://login.salesforce.com
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/data/v64.0/sobjects/LightningUsageByAppTypeMetrics:
parameters: []
get:
tags:
- Applications
summary: Salesforce Lightning Usage by App Type
description: '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'
operationId: LightningUsagebyAppType
parameters:
- name: Content-Type
in: header
description: ''
required: true
schema:
const: application/json
type: string
examples:
- application/json
example: example_value
responses:
'200':
description: ''
headers: {}
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/data/v64.0/ui-api/apps:
parameters: []
get:
tags:
- Applications
summary: Salesforce Get Apps
description: 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.
operationId: GetApps
parameters:
- name: formFactor
in: query
description: The form factor for each app that the user has access to (`Large`, `Medium` or `Small`)
required: true
style: form
explode: true
schema:
type: string
examples:
- Large
example: example_value
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Fri, 06 Oct 2023 09:27:10 GMT
Strict-Transport-Security:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: max-age=63072000; includeSubDomains
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
X-Robots-Tag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: none
Cache-Control:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: no-cache,must-revalidate,max-age=0,no-store,private
ETag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: '"619eb2f896db72ff9a0823ed6a551e66--gzip"'
Vary:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Accept-Encoding
Content-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: gzip
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
content:
application/json;charset=UTF-8:
schema:
allOf:
- $ref: '#/components/schemas/GetApps'
- examples:
- apps:
- appId: 06m58000000fBK2AAM
description: Manage your sales process with accounts, leads, opportunities, and more
developerName: LightningSales
eTag: e288a1d753c535d52fd11b047cd74482
formFactors:
- Small
- Medium
- Large
headerColor: '#0070D2'
iconUrl: https://pozil-dev-ed.my.salesforce.com/logos/Salesforce/SalesCloud/icon.png
isNavAutoTempTabsDisabled: false
isNavPersonalizationDisabled: false
isNavTabPersistenceDisabled: false
label: Sales
logoUrl: https://pozil-dev-ed.my.salesforce.com/logos/Salesforce/SalesCloud/logo.png
mobileStartUrl: null
navItems:
- availableInClassic: true
availableInLightning: true
color: FF538A
content: https://pozil-dev-ed.my.salesforce.com/lightning/page/home
custom: false
developerName: standard-home
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/home_120.png
id: null
itemType: Standard
label: Home
objectApiName: Home
objectLabel: null
objectLabelPlural: null
pageReference:
attributes:
pageName: home
state: {}
type: standard__namedPage
standardType: Home
- availableInClassic: true
availableInLightning: true
color: FF5D2D
content: https://pozil-dev-ed.my.salesforce.com/006/o
custom: false
developerName: standard-Opportunity
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/opportunity_120.png
id: null
itemType: Entity
label: Opportunities
objectApiName: Opportunity
objectLabel: Opportunity
objectLabelPlural: Opportunities
pageReference:
attributes:
objectApiName: Opportunity
actionName: home
state: {}
type: standard__objectPage
standardType: null
- availableInClassic: true
availableInLightning: true
color: FF5D2D
content: https://pozil-dev-ed.my.salesforce.com/00Q/o
custom: false
developerName: standard-Lead
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/lead_120.png
id: null
itemType: Entity
label: Leads
objectApiName: Lead
objectLabel: Lead
objectLabelPlural: Leads
pageReference:
attributes:
objectApiName: Lead
actionName: home
state: {}
type: standard__objectPage
standardType: null
- availableInClassic: false
availableInLightning: true
color: 3BA755
content: https://pozil-dev-ed.my.salesforce.com/00T/o
custom: false
developerName: standard-Task
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/task_120.png
id: null
itemType: Standard
label: Tasks
objectApiName: Task
objectLabel: Task
objectLabelPlural: Tasks
pageReference:
attributes:
objectApiName: Task
actionName: home
state: {}
type: standard__objectPage
standardType: Tasks
- availableInClassic: true
availableInLightning: true
color: '939393'
content: https://pozil-dev-ed.my.salesforce.com/_ui/core/chatter/files/FileTabPage
custom: false
developerName: standard-File
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/file_120.png
id: null
itemType: Entity
label: Files
objectApiName: ContentDocument
objectLabel: null
objectLabelPlural: null
pageReference:
attributes:
objectApiName: ContentDocument
actionName: home
state: {}
type: standard__objectPage
standardType: null
- availableInClassic: true
availableInLightning: true
color: 5867E8
content: https://pozil-dev-ed.my.salesforce.com/001/o
custom: false
developerName: standard-Account
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png
id: null
itemType: Entity
label: Accounts
objectApiName: Account
objectLabel: Account
objectLabelPlural: Accounts
pageReference:
attributes:
objectApiName: Account
actionName: home
state: {}
type: standard__objectPage
standardType: null
- availableInClassic: true
availableInLightning: true
color: 5867E8
content: https://pozil-dev-ed.my.salesforce.com/003/o
custom: false
developerName: standard-Contact
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/contact_120.png
id: null
itemType: Entity
label: Contacts
objectApiName: Contact
objectLabel: Contact
objectLabelPlural: Contacts
pageReference:
attributes:
objectApiName: Contact
actionName: home
state: {}
type: standard__objectPage
standardType: null
- availableInClassic: true
availableInLightning: true
color: FF538A
content: https://pozil-dev-ed.my.salesforce.com/01Z/o
custom: false
developerName: standard-Dashboard
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/dashboard_120.png
id: null
itemType: Standard
label: Dashboards
objectApiName: Dashboard
objectLabel: Dashboard
objectLabelPlural: Dashboards
pageReference:
attributes:
objectApiName: Dashboard
actionName: home
state: {}
type: standard__objectPage
standardType: Dashboards
- availableInClassic: true
availableInLightning: true
color: 06A59A
content: https://pozil-dev-ed.my.salesforce.com/00O/o
custom: false
developerName: standard-report
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_120.png
id: null
itemType: Standard
label: Reports
objectApiName: Report
objectLabel: Report
objectLabelPlural: Reports
pageReference:
attributes:
objectApiName: Report
actionName: home
state: {}
type: standard__objectPage
standardType: Reports
- availableInClassic: false
availableInLightning: true
color: 1B96FF
content: null
custom: false
developerName: standard-Feed
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/feed_120.png
id: null
itemType: Standard
label: Chatter
objectApiName: Feed
objectLabel: null
objectLabelPlural: null
pageReference:
attributes:
pageName: chatter
state: {}
type: standard__namedPage
standardType: Feed
- availableInClassic: true
availableInLightning: true
color: 1B96FF
content: https://pozil-dev-ed.my.salesforce.com/_ui/core/chatter/groups/GroupListPage
custom: false
developerName: standard-CollaborationGroup
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/groups_120.png
id: null
itemType: Standard
label: Groups
objectApiName: CollaborationGroup
objectLabel: Group
objectLabelPlural: Groups
pageReference:
attributes:
objectApiName: CollaborationGroup
actionName: home
state: {}
type: standard__objectPage
standardType: Groups
- availableInClassic: false
availableInLightning: true
color: FF538A
content: https://pozil-dev-ed.my.salesforce.com/00U/o
custom: false
developerName: standard-Event
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/event_120.png
id: null
itemType: Standard
label: Calendar
objectApiName: Event
objectLabel: Event
objectLabelPlural: Events
pageReference:
attributes:
objectApiName: Event
actionName: home
state: {}
type: standard__objectPage
standardType: Events
- availableInClassic: true
availableInLightning: true
color: 1B96FF
content: https://pozil-dev-ed.my.salesforce.com/_ui/core/chatter/people/PeopleListPage
custom: false
developerName: standard-OtherUserProfile
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/user_120.png
id: null
itemType: Standard
label: People
objectApiName: User
objectLabel: User
objectLabelPlural: People
pageReference:
attributes:
objectApiName: User
actionName: home
state: {}
type: standard__objectPage
standardType: People
- availableInClassic: true
availableInLightning: true
color: FF5D2D
content: https://pozil-dev-ed.my.salesforce.com/500/o
custom: false
developerName: standard-Case
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/case_120.png
id: null
itemType: Entity
label: Cases
objectApiName: Case
objectLabel: Case
objectLabelPlural: Cases
pageReference:
attributes:
objectApiName: Case
actionName: home
state: {}
type: standard__objectPage
standardType: null
- availableInClassic: true
availableInLightning: true
color: 3BA755
content: https://pozil-dev-ed.my.salesforce.com/_ui/sales/forecasting/ui/ForecastingTabPage
custom: false
developerName: standard-Forecasting3
iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/forecasts_120.png
id: null
itemType: Standard
label: Forecasts
objectApiName: Forecasting3
objectLabel: null
objectLabelPlural: null
pageReference:
attributes:
pageName: forecasting
state: {}
type: standard__namedPage
standardType: Forecasting3
selected: true
startUrl: https://pozil-dev-ed.my.salesforce.com/home/home.jsp?tsid=02u58000000fBK2
type: Lightning
userNavItems: []
- appId: 06m58000000dRxBAAU
description: Manage customer service with accounts, contacts, cases, and more
developerName: Service
eTag: b8b5942342984b0853126b7a7558e130
formFactors:
- Large
headerColor: '#0070D2'
iconUrl: https://pozil-dev-ed.my.salesforce.com/logos/Salesforce/ServiceCloud/icon.png
isNavAutoTempTabsDisabled: false
isNavPersonalizationDisabled: false
isNavTabPersistenceDisabled: false
label: Service
logoUrl: https://pozil-dev-ed.my.salesforce.com/logos/Salesforce/ServiceCloud/logo.png
mobileStartUrl: null
navItems: []
selected: false
startUrl: https://pozil-dev-ed.my.salesforce.com/home/home.jsp?tsid=02u58000000dRxB
type: Classic
userNavItems: []
- appId: 06m58000000dRxCAAU
description: Best-in-class on-demand marketing automation
developerName: Marketing
eTag: ffedb4e8ce9ada4905724cd13c74955e
formFactors:
- Large
headerColor: '#0070D2'
iconUrl: https://pozil-dev-ed.my.salesforce.com/logos/Salesforce/MarketingCloud/icon.png
isNavAutoTempTabsDisabled: false
isNavPersonalizationDisabled: false
isNavTabPersistenceDisabled: false
label: Marketing
logoUrl: https://pozil-dev-ed.my.salesforce.com/logos/Salesforce/MarketingCloud/logo.png
mobileStartUrl: null
navItems: []
selected: false
startUrl: https://pozil-dev-ed.my.salesforce.com/home/home.jsp?tsid=02u58000000dRxC
type: Classic
userNavItems: []
- appId: 06m58000000dRx2AAE
description: Salesforce CRM Communities
developerName: Community
eTag: 12283186521e9dff9e4440f9f83b7a4d
formFactors:
- Large
headerColor: '#0070D2'
iconUrl: https://pozil-dev-ed.my.salesforce.com/logos/Salesforce/Community/icon.png
isNavAutoTempTabsDisabled: false
isNavPersonalizationDisabled: false
isNavTabPersistenceDisabled: false
label: Community
logoUrl: https://pozil-dev-ed.my.salesforce.com/logos/Salesforce/Community/logo.png
mobileStartUrl: null
navItems: []
selected: false
startUrl: https://pozil-dev-ed.my.salesforce.com/home/home.jsp?tsid=02u58000000dRx2
type: Classic
userNavItems: []
- appId: 06m58000000dRx3AAE
description: Build pixel-perfect, data-rich websites using the drag-and-drop Site.com application, and manage content and published sites.
developerName: Sites
eTag: 0f40c4dd79d400146f97c64b1cf7d865
formFactors:
- Large
headerColor: '#0070D2'
iconUrl: https://pozil-dev-ed.my.salesforce.com/logos/Salesforce/Sites/icon.png
isNavAutoTempTabsDisabled: false
isNavPersonalizationDisabled: false
isNavTabPersistenceDisabled: false
label: Site.com
logoUrl: https://pozil-dev-ed.my.salesforce.com/logos/app/00D58000000arpq/02u58000000dRx3AAE
mobileStartUrl: null
navItems: []
selected: false
startUrl: https://pozil-dev-ed.my.salesforce.com/home/home.jsp?tsid=02u58000000dRx3
type: Classic
userNavItems: []
- appId: 06m58000000dRx4AAE
description: The Salesforce Chatter social network, including profiles and feeds
developerName: Chatter
eTag: 95c37da7ec4eee2c9a96d53d7ce9b89b
formFactors:
- Large
headerColor: '#0070D2'
iconUrl: https://pozil-dev-ed.my.salesforce.com/logos/Salesforce/Chatter/icon.png
isNavAutoTempTabsDisabled: false
isNavPersonalizationDisabled: false
isNavTabPersistenceDisabled: false
label: Salesforce Chatter
logoUrl: https://pozil-dev-ed.my.salesforce.com/logos/Standard/feed/logo.svg
mobileStartUrl: null
navItems: []
selected: false
startUrl: https://pozil-dev-ed.my.salesforce.com/home/home.jsp?tsid=02u58000000dRx4
type: Classic
userNavItems: []
- appId: 06m58000000dRx9AAE
description: Salesforce CRM Content
developerName: Content
eTag: edeb0edc6c931a4b3ebb4c08bc7c4c21
formFactors:
- Large
headerCo
# --- truncated at 32 KB (232 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-applications-api-openapi.yml