Salesforce · JSON Structure
Salesforce Retrieve Open Api Schema Structure
Type: object
Properties: 6
Required: 6
Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales
RetrieveOpenAPISchema is a JSON Structure definition published by Salesforce, describing 6 properties, of which 6 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.
Properties
openapi
info
servers
security
paths
components
Meta-schema: https://json-structure.org/draft/2020-12/schema
JSON Structure
{
"type": "object",
"name": "RetrieveOpenAPISchema",
"properties": {
"openapi": {
"type": "string"
},
"info": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"title",
"description",
"version"
]
},
"servers": {
"type": "array",
"description": "",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": [
"url"
]
}
},
"security": {
"type": "array",
"description": "",
"items": {
"type": "object",
"properties": {
"bearerAuth": {
"type": "array",
"description": "",
"items": {
"type": "string"
}
},
"oAuth2": {
"type": "array",
"description": "",
"items": {
"type": "string"
}
},
"openIDConnectDiscovery": {
"type": "array",
"description": "",
"items": {
"type": "string"
}
}
}
}
},
"paths": {
"type": "object",
"properties": {
"/sobjects/Contact": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"get": {
"type": "object",
"properties": {
"responses": {
"type": "object"
}
},
"required": [
"responses"
]
},
"post": {
"type": "object",
"properties": {
"parameters": {
"type": "array",
"description": "",
"items": {
"type": "object",
"properties": {
"name": {
"type": "object"
},
"in": {
"type": "object"
},
"description": {
"type": "object"
},
"required": {
"type": "object"
},
"schema": {
"type": "object"
}
},
"required": [
"name",
"in",
"description",
"required",
"schema"
]
}
},
"requestBody": {
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {
"application/json": {
"type": "object"
}
},
"required": [
"application/json"
]
}
},
"required": [
"content"
]
},
"responses": {
"type": "object"
}
},
"required": [
"parameters",
"requestBody",
"responses"
]
}
},
"required": [
"description",
"get",
"post"
]
}
},
"required": [
"/sobjects/Contact"
]
},
"components": {
"type": "object",
"properties": {
"schemas": {
"type": "object",
"properties": {
"SObjectRootInfo": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"properties": {
"type": "object",
"properties": {
"objectDescribe": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"properties": {
"type": "object"
}
},
"required": [
"type",
"properties"
]
},
"recentItems": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"items": {
"type": "object"
}
},
"required": [
"type",
"items"
]
}
},
"required": [
"objectDescribe",
"recentItems"
]
}
},
"required": [
"type",
"properties"
]
},
"RestApiError": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"properties": {
"type": "object",
"properties": {
"errorCode": {
"type": "object",
"properties": {
"type": {
"type": "object"
}
},
"required": [
"type"
]
},
"message": {
"type": "object",
"properties": {
"type": {
"type": "object"
}
},
"required": [
"type"
]
}
},
"required": [
"errorCode",
"message"
]
}
},
"required": [
"type",
"properties"
]
},
"AccountSObject": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"properties": {
"type": "object",
"properties": {
"Id": {
"type": "object",
"properties": {
"type": {
"type": "object"
}
},
"required": [
"type"
]
},
"IsDeleted": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"MasterRecordId": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"Name": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"Type": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"ParentId": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"BillingStreet": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"BillingCity": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"BillingState": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"BillingPostalCode": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"BillingCountry": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"BillingLatitude": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"BillingLongitude": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"BillingGeocodeAccuracy": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"BillingAddress": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"ShippingStreet": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"ShippingCity": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"ShippingState": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"ShippingPostalCode": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"ShippingCountry": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"ShippingLatitude": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"ShippingLongitude": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"ShippingGeocodeAccuracy": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"ShippingAddress": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"Phone": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"Fax": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"AccountNumber": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"Website": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"PhotoUrl": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"Sic": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"Industry": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"AnnualRevenue": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"NumberOfEmployees": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"Ownership": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"TickerSymbol": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"Description": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"Rating": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"Site": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"OwnerId": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"CreatedDate": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"format": {
"type": "object"
}
},
"required": [
"type",
"format"
]
},
"CreatedById": {
"type": "object",
"properties": {
"type": {
"type": "object"
}
},
"required": [
"type"
]
},
"LastModifiedDate": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"format": {
"type": "object"
}
},
"required": [
"type",
"format"
]
},
"LastModifiedById": {
"type": "object",
"properties": {
"type": {
"type": "object"
}
},
"required": [
"type"
]
},
"SystemModstamp": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"format": {
"type": "object"
}
},
"required": [
"type",
"format"
]
},
"LastActivityDate": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
},
"format": {
"type": "object"
}
},
"required": [
"type",
"description",
"format"
]
},
"LastViewedDate": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
},
"format": {
"type": "object"
}
},
"required": [
"type",
"description",
"format"
]
},
"LastReferencedDate": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
},
"format": {
"type": "object"
}
},
"required": [
"type",
"description",
"format"
]
},
"IsPartner": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"IsCustomerPortal": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"ChannelProgramName": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"description": {
"type": "object"
}
},
"required": [
"type",
"description"
]
},
"ChannelProgramLevelName": {
"type": "object",
"properties": {
"type": {
# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/json-structure/salesforce-retrieve-open-api-schema-structure.json