openapi: 3.1.0
info:
title: Salesforce Bulk API 2.0 Abort Schema 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: Schema
paths:
/data/v64.0/event/eventSchema/{SCHEMA_ID}:
parameters: []
get:
tags:
- Schema
summary: Salesforce Platform Event Schema by Schema Id
description: Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.
operationId: PlatformEventSchemabySchemaID
parameters:
- name: SCHEMA_ID
in: path
description: ''
required: true
schema:
type: string
example: '500123'
- 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/sobjects/{EVENT_NAME}/eventSchema:
parameters: []
get:
tags:
- Schema
summary: Salesforce Platform Event Schema by Event Name
description: Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.
operationId: PlatformEventSchemabyEventName
parameters:
- name: EVENT_NAME
in: path
description: API Name of the event
required: true
schema:
type: string
example: example_value
- name: Content-Type
in: header
description: ''
required: true
schema:
const: application/json
type: string
examples:
- application/json
example: example_value
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Mon, 03 Jul 2023 13:06:08 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
Sforce-Limit-Info:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: api-usage=2/15000
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:
$ref: '#/components/schemas/PlatformEventSchemabyEventName'
examples:
Platformeventschemabyeventname200Example:
summary: Default PlatformEventSchemabyEventName 200 response
x-microcks-default: true
value:
name: Example Title
namespace: example_value
type: example_value
fields:
- name: Example Title
type: example_value
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/async/specifications/oas3:
parameters: []
post:
tags:
- Schema
summary: Salesforce Request Openapi Schema
description: Requests an Open API document for the selected SObject REST API resources.
operationId: RequestOpenAPISchema
parameters: []
requestBody:
description: ''
content:
text/plain:
schema:
type: string
examples:
- "{\n \"resources\": [\n YOUR_SOBJECT_SELECTORS\n ]\n}"
contentMediaType: text/plain
example: "{\n \"resources\": [\n YOUR_SOBJECT_SELECTORS\n ]\n}"
required: true
responses:
'202':
description: Accepted
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Mon, 26 Feb 2024 13:50:18 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
Sforce-Limit-Info:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: api-usage=9/15000
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/GenerateOpenAPISchema'
- examples:
- href: /v59.0/async/specifications/oas3/NTByNEgwMDAwMDAwMDAx
contentMediaType: application/json;charset=UTF-8
example:
href: /v59.0/async/specifications/oas3/NTByNEgwMDAwMDAwMDAx
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/async/specifications/oas3/{schemaId}:
parameters: []
get:
tags:
- Schema
summary: Salesforce Retrieve Openapi Schema
description: Generate an OpenAPI 3.0 document for the sObjects REST API. This is a [Beta feature](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/openapi_beta.htm) that requires an activation step before it can be used.
operationId: RetrieveOpenAPISchema
parameters:
- name: schemaId
in: path
description: Identifier that was returned in the original request to generate the Schema.
required: true
schema:
type: string
example: '500123'
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Mon, 26 Feb 2024 13:53:54 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
Sforce-Limit-Info:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: api-usage=11/15000
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:
schema:
$ref: '#/components/schemas/RetrieveOpenAPISchema'
examples:
Retrieveopenapischema200Example:
summary: Default RetrieveOpenAPISchema 200 response
x-microcks-default: true
value:
openapi: example_value
info:
title: Example Title
description: A sample description.
version: example_value
servers:
- url: https://www.example.com
security:
- bearerAuth: {}
oAuth2: {}
openIDConnectDiscovery: {}
paths: {}
components: {}
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
Type:
title: Type
type: object
properties:
type:
type: string
example: example_value
name:
type: string
example: Example Title
namespace:
type: string
example: example_value
fields:
type: array
items:
$ref: '#/components/schemas/Field3'
description: ''
example: []
Scopes1:
title: Scopes1
required:
- api
type: object
properties:
api:
type: string
example: example_value
examples:
- api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources.
MailingPostalCode:
title: MailingPostalCode
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: string
description: Mailing address details.
MailingGeocodeAccuracy:
title: MailingGeocodeAccuracy
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: string
description: Accuracy level of the geocode for the mailing address. For details on geolocation compound field, see .
AssistantPhone:
title: AssistantPhone
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: string
description: The assistant’s telephone number.
NumberofLocationsC:
title: NumberofLocationsC
required:
- type
type: object
properties:
type:
type: string
example: example_value
examples:
- type: number
Fax:
title: Fax
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: string
description: Fax number for the account.
Tradestyle:
title: Tradestyle
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: string
description: A name, different from its legal name, that an org may use for conducting business. Similar to “Doing business as” or “DBA”. Maximum length is 255 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean.
IsSubtype:
title: IsSubtype
required:
- type
type: object
properties:
type:
type: string
example: example_value
examples:
- type: boolean
ShippingAddress:
title: ShippingAddress
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: object
description: The compound form of the shipping address. Read-only. See Address Compound Fields for details on compound address fields.
SobjectsContact:
title: SobjectsContact
required:
- description
- get
- post
type: object
properties:
description:
type: string
example: A sample description.
get:
$ref: '#/components/schemas/Get'
post:
$ref: '#/components/schemas/Post'
MailingLongitude:
title: MailingLongitude
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: number
description: Used with MailingLatitude to specify the precise geolocation of a mailing address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see .
Searchable:
title: Searchable
required:
- type
type: object
properties:
type:
type: string
example: example_value
examples:
- type: boolean
RestApiError:
title: RestApiError
required:
- type
- properties
type: object
properties:
type:
type: string
example: example_value
properties:
$ref: '#/components/schemas/Properties3'
examples:
- type: object
properties:
errorCode:
type: string
message:
type: string
RetrieveOpenAPISchema:
title: RetrieveOpenAPISchema
required:
- openapi
- info
- servers
- security
- paths
- components
type: object
properties:
openapi:
type: string
example: example_value
info:
$ref: '#/components/schemas/Info'
servers:
type: array
items:
$ref: '#/components/schemas/Server'
description: ''
example: []
security:
type: array
items:
$ref: '#/components/schemas/Security'
description: ''
example: []
paths:
$ref: '#/components/schemas/Paths'
components:
$ref: '#/components/schemas/Components'
ReportsToId:
title: ReportsToId
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: string
description: This field doesn’t appear if IsPersonAccount is true.
MailingCountry:
title: MailingCountry
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: string
description: Mailing address details.
Deletable:
title: Deletable
required:
- type
type: object
properties:
type:
type: string
example: example_value
examples:
- type: boolean
OtherCity:
title: OtherCity
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: string
description: Alternate address details.
Title:
title: Title
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: string
description: Title of the contact, such as CEO or Vice President.
OtherCountry:
title: OtherCountry
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: string
description: Alternate address details.
Phone:
title: Phone
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: string
description: Phone number for this account. Maximum size is 40 characters.
Info:
title: Info
required:
- title
- description
- version
type: object
properties:
title:
type: string
example: Example Title
description:
type: string
example: A sample description.
version:
type: string
example: example_value
examples:
- title: Lightning Platform REST API
description: 'REST API provides you with programmatic access to your data in Salesforce. The flexibility and scalability of REST API make it an excellent choice for integrating Salesforce into your applications and for performing complex operations on a large scale. You can use REST API tools to create, manipulate, and search data in Salesforce by sending HTTP requests to endpoints in Salesforce. Depending on where you send requests, you access and operate on different pieces of information, called resources. Resources include records, query results, metadata, and more. '
version: '60.0'
LastCURequestDate:
title: LastCURequestDate
required:
- type
- format
type: object
properties:
type:
type: string
example: example_value
format:
type: string
example: example_value
examples:
- type: string
format: date-time
Field5:
title: Field5
required:
- name
- type
type: object
properties:
name:
type: string
example: Example Title
type:
oneOf:
- type: array
items:
type: string
- type: array
items:
type: string
example: example_value
doc:
type: string
example: example_value
default:
type:
- string
- 'null'
example: example_value
Content:
title: Content
required:
- application/json
type: object
properties:
application/json:
$ref: '#/components/schemas/ApplicationJson'
examples:
- application/json:
schema:
$ref: '#/components/schemas/SObjectRootInfo'
Properties1:
title: Properties1
required:
- name
- label
- labelPlural
- keyPrefix
- custom
- customSetting
- activateable
- createable
- updateable
- deletable
- undeletable
- mergeable
- replicateable
- triggerable
- queryable
- retrieveable
- searchable
- layoutable
- feedEnabled
- mruEnabled
- hasSubtypes
- isSubtype
- dataTranslationEnabled
- isInterface
- deepCloneable
- associateEntityType
- associateParentEntity
- deprecatedAndHidden
- urls
type: object
properties:
name:
$ref: '#/components/schemas/Name13'
label:
$ref: '#/components/schemas/Label'
labelPlural:
$ref: '#/components/schemas/LabelPlural'
keyPrefix:
$ref: '#/components/schemas/KeyPrefix'
custom:
$ref: '#/components/schemas/Custom'
customSetting:
$ref: '#/components/schemas/CustomSetting'
activateable:
$ref: '#/components/schemas/Activateable'
createable:
$ref: '#/components/schemas/Createable'
updateable:
$ref: '#/components/schemas/Updateable'
deletable:
$ref: '#/components/schemas/Deletable'
undeletable:
$ref: '#/components/schemas/Undeletable'
mergeable:
$ref: '#/components/schemas/Mergeable'
replicateable:
$ref: '#/components/schemas/Replicateable'
triggerable:
$ref: '#/components/schemas/Triggerable'
queryable:
$ref: '#/components/schemas/Queryable'
retrieveable:
$ref: '#/components/schemas/Retrieveable'
searchable:
$ref: '#/components/schemas/Searchable'
layoutable:
$ref: '#/components/schemas/Layoutable'
feedEnabled:
$ref: '#/components/schemas/FeedEnabled'
mruEnabled:
$ref: '#/components/schemas/MruEnabled'
hasSubtypes:
$ref: '#/components/schemas/HasSubtypes'
isSubtype:
$ref: '#/components/schemas/IsSubtype'
dataTranslationEnabled:
$ref: '#/components/schemas/DataTranslationEnabled'
isInterface:
$ref: '#/components/schemas/IsInterface'
deepCloneable:
$ref: '#/components/schemas/DeepCloneable'
associateEntityType:
$ref: '#/components/schemas/AssociateEntityType'
associateParentEntity:
$ref: '#/components/schemas/AssociateParentEntity'
deprecatedAndHidden:
$ref: '#/components/schemas/DeprecatedAndHidden'
urls:
$ref: '#/components/schemas/Urls5'
examples:
- name:
type: string
label:
type: string
labelPlural:
type: string
keyPrefix:
type: string
custom:
type: boolean
customSetting:
type: boolean
activateable:
type: boolean
createable:
type: boolean
updateable:
type: boolean
deletable:
type: boolean
undeletable:
type: boolean
mergeable:
type: boolean
replicateable:
type: boolean
triggerable:
type: boolean
queryable:
type: boolean
retrieveable:
type: boolean
searchable:
type: boolean
layoutable:
type: boolean
feedEnabled:
type: boolean
mruEnabled:
type: boolean
hasSubtypes:
type: boolean
isSubtype:
type: boolean
dataTranslationEnabled:
type: boolean
isInterface:
type: boolean
deepCloneable:
type: boolean
associateEntityType:
type: string
associateParentEntity:
type: string
deprecatedAndHidden:
type: boolean
urls:
type: object
additionalProperties:
type: string
OtherState:
title: OtherState
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: string
description: Alternate address details.
Type5:
title: Type5
required:
- type
type: object
properties:
type:
type: string
example: example_value
examples:
- type: string
OtherGeocodeAccuracy:
title: OtherGeocodeAccuracy
required:
- type
- description
type: object
properties:
type:
type: string
example: example_value
description:
type: string
example: A sample description.
examples:
- type: string
description: Accuracy level of the geocode for the other address. For details on geolocation compound fields, see .
Createable:
title: Createable
required:
- type
type: object
properties:
type:
type: string
example: example_value
examples:
- type: boolean
Items23:
title: Items23
required:
- type
- properties
type: object
properties:
type:
type: string
example: example_value
properties:
$ref: '#/components/schemas/Properties10'
examples:
- type: object
properties:
message:
type: string
statusCode:
type: string
extendedDetails:
type: array
items:
type: object
properties:
extendedErrorCode:
type: string
ContactSObject:
title: ContactSObject
required:
- type
- properties
- description
type: object
properties:
type:
type: string
example: example_value
properties:
$ref: '#/components/schemas/Properties12'
description:
type: string
example: A sample description.
examples:
- type: object
properties:
Id:
type: string
IsDeleted:
type: boolean
description: Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
MasterRecordId:
type: string
description: If this record was deleted as the result of a merge, this field contains the ID of the record that remains. If this record was deleted for any other reason, or has not been deleted, the value is null.
AccountId:
type: string
description: ID of the account that’s the parent of this contact. We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours.
LastName:
type: string
description: Required. Last name of the contact up to 80 characters.
FirstName:
type: string
description: The contact’s first name up to 40 characters.
Salutation:
type: string
description: Honorific abbreviation, word, or phrase to be used in front of name in greetings, such as Dr. or Mrs.
Name:
type: string
description: Concatenation of FirstName, MiddleName, LastName, and Suffix up to 203 characters, including whitespaces.
OtherStreet:
type: string
description: Street for alternate address.
OtherCity:
type: string
# --- truncated at 32 KB (281 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-schema-api-openapi.yml