Salesforce · Example Payload

Salesforce Retrieve Open Api Schema Example

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Salesforce Retrieve Open Api Schema Example is an example object payload from Salesforce, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

openapiinfoserverssecuritypathscomponents

Example Payload

Raw ↑
{
  "openapi": "example_value",
  "info": {
    "title": "Example Title",
    "description": "A sample description.",
    "version": "example_value"
  },
  "servers": [],
  "security": [],
  "paths": {
    "/sobjects/Contact": {
      "description": "A sample description.",
      "get": {
        "responses": "example_value"
      },
      "post": {
        "parameters": [],
        "requestBody": {
          "content": {}
        },
        "responses": "example_value"
      }
    }
  },
  "components": {
    "schemas": {
      "SObjectRootInfo": {
        "type": "example_value",
        "properties": {
          "objectDescribe": {},
          "recentItems": {}
        }
      },
      "RestApiError": {
        "type": "example_value",
        "properties": {
          "errorCode": {},
          "message": {}
        }
      },
      "AccountSObject": {
        "type": "example_value",
        "properties": {
          "Id": {},
          "IsDeleted": {},
          "MasterRecordId": {},
          "Name": {},
          "Type": {},
          "ParentId": {},
          "BillingStreet": {},
          "BillingCity": {},
          "BillingState": {},
          "BillingPostalCode": {},
          "BillingCountry": {},
          "BillingLatitude": {},
          "BillingLongitude": {},
          "BillingGeocodeAccuracy": {},
          "BillingAddress": {},
          "ShippingStreet": {},
          "ShippingCity": {},
          "ShippingState": {},
          "ShippingPostalCode": {},
          "ShippingCountry": {},
          "ShippingLatitude": {},
          "ShippingLongitude": {},
          "ShippingGeocodeAccuracy": {},
          "ShippingAddress": {},
          "Phone": {},
          "Fax": {},
          "AccountNumber": {},
          "Website": {},
          "PhotoUrl": {},
          "Sic": {},
          "Industry": {},
          "AnnualRevenue": {},
          "NumberOfEmployees": {},
          "Ownership": {},
          "TickerSymbol": {},
          "Description": {},
          "Rating": {},
          "Site": {},
          "OwnerId": {},
          "CreatedDate": {},
          "CreatedById": {},
          "LastModifiedDate": {},
          "LastModifiedById": {},
          "SystemModstamp": {},
          "LastActivityDate": {},
          "LastViewedDate": {},
          "LastReferencedDate": {},
          "IsPartner": {},
          "IsCustomerPortal": {},
          "ChannelProgramName": {},
          "ChannelProgramLevelName": {},
          "Jigsaw": {},
          "JigsawCompanyId": {},
          "CleanStatus": {},
          "AccountSource": {},
          "DunsNumber": {},
          "Tradestyle": {},
          "NaicsCode": {},
          "NaicsDesc": {},
          "YearStarted": {},
          "SicDesc": {},
          "DandbCompanyId": {},
          "CustomerPriority__c": {},
          "SLA__c": {},
          "Active__c": {},
          "NumberofLocations__c": {},
          "UpsellOpportunity__c": {},
          "SLASerialNumber__c": {},
          "SLAExpirationDate__c": {},
          "Potential_Value__c": {},
          "Match_Billing_Address__c": {},
          "Number_of_Contacts__c": {},
          "Region__c": {},
          "attributes": {}
        },
        "description": "A sample description."
      },
      "ErrorInfo": {
        "type": "example_value",
        "properties": {
          "message": {},
          "errorCode": {},
          "fields": {},
          "extendedErrorDetails": {}
        }
      },
      "SaveResult": {
        "type": "example_value",
        "properties": {
          "success": {},
          "id": {},
          "errors": {},
          "warnings": {},
          "infos": {}
        }
      },
      "ContactSObject": {
        "type": "example_value",
        "properties": {
          "Id": {},
          "IsDeleted": {},
          "MasterRecordId": {},
          "AccountId": {},
          "LastName": {},
          "FirstName": {},
          "Salutation": {},
          "Name": {},
          "OtherStreet": {},
          "OtherCity": {},
          "OtherState": {},
          "OtherPostalCode": {},
          "OtherCountry": {},
          "OtherLatitude": {},
          "OtherLongitude": {},
          "OtherGeocodeAccuracy": {},
          "OtherAddress": {},
          "MailingStreet": {},
          "MailingCity": {},
          "MailingState": {},
          "MailingPostalCode": {},
          "MailingCountry": {},
          "MailingLatitude": {},
          "MailingLongitude": {},
          "MailingGeocodeAccuracy": {},
          "MailingAddress": {},
          "Phone": {},
          "Fax": {},
          "MobilePhone": {},
          "HomePhone": {},
          "OtherPhone": {},
          "AssistantPhone": {},
          "ReportsToId": {},
          "Email": {},
          "Title": {},
          "Department": {},
          "AssistantName": {},
          "LeadSource": {},
          "Birthdate": {},
          "Description": {},
          "OwnerId": {},
          "CreatedDate": {},
          "CreatedById": {},
          "LastModifiedDate": {},
          "LastModifiedById": {},
          "SystemModstamp": {},
          "LastActivityDate": {},
          "LastCURequestDate": {},
          "LastCUUpdateDate": {},
          "LastViewedDate": {},
          "LastReferencedDate": {},
          "EmailBouncedReason": {},
          "EmailBouncedDate": {},
          "IsEmailBounced": {},
          "PhotoUrl": {},
          "Jigsaw": {},
          "JigsawContactId": {},
          "CleanStatus": {},
          "IndividualId": {},
          "attributes": {}
        },
        "description": "A sample description."
      }
    },
    "securitySchemes": {
      "openIDConnectDiscovery": "500123",
      "bearerAuth": {
        "type": "example_value",
        "description": "A sample description.",
        "scheme": "example_value"
      },
      "oAuth2": {
        "type": "example_value",
        "description": "A sample description.",
        "flows": {
          "implicit": {},
          "password": {},
          "authorizationCode": {}
        }
      }
    }
  }
}