Release Status Released Supported By Stitch
Availability Paid Status Page Salesforce Status Page
Default Historical Sync 1 year Default Replication Frequency 1 hour
Whitelisting Tables and columns Destination Incompatibilities None

Connecting Salesforce

Salesforce Setup requirements

To set up Salesforce in Stitch, you need:

  • A paid Stitch plan. While those currently in the Free Trial will also be able to set up Salesforce, replication will be paused until a paid plan is selected after the trial ends.
  • To verify your object access. Stitch will only be able to access and replicate the objects that the user setting up the integration has access to. Before beginning, we recommend verifying that you have access to everything you want to replicate.

  • To verify your API access. To use Stitch’s Salesforce integration, your Salesforce account must have Web Service API access enabled.

    Some editions of Salesforce include Web Service API access while others don’t. Info about this feature can be found on Salesforce’s plan details page in the Connect sales info to any app section, located near the bottom of the page.

    Contact Salesforce support if you’re unsure about your Salesforce plan’s API access.

Step 1: Set trusted IPs in Salesforce

Depending on how your Salesforce instance is set up, you may need to whitelist Stitch’s IP addresses. In Salesforce, this is referred to as “setting trusted IPs”.

The instructions in this Salesforce article will walk you through how to do this in Salesforce. Note: Because these are exact IP addresses and not ranges, the same IP address must be entered in the Start IP Address and End IP Address fields in Salesforce.

Add the following IP addresses to the trusted list:

  • 52.23.137.21/32

  • 52.204.223.208/32

  • 52.204.228.32/32

  • 52.204.230.227/32

Complete this step before proceeding with the rest of the setup, or you may encounter connection issues.

Step 2: Add Salesforce as a Stitch data source

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Salesforce icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Salesforce” would create a schema called stitch_salesforce in the destination. Note: Schema names cannot be changed after you save the integration.

  5. If the instance you want to connect to Stitch is a sandbox, check the Connect to a Sandbox Environment box.

Step 3: Configure Stitch's Salesforce API Usage

Usage of the Salesforce API depends on two factors:

  1. The type of API used for data extraction (Bulk vs REST), and
  2. The amount of standard API quota your account has. An API quota refers to the total number of API requests that can be made in a given period of time.

Stitch’s Salesforce integration allows you to control both of these settings so you can replicate data as you see fit.

Step 3.1: Select extraction API

If you’re not sure which API you should use, take a look at the brief comparison below. Consider how much data you need to replicate, how often you require updates, how many additional apps are connected to your Salesforce instance, and so on.

Once you’ve decided, click radio button next to the API you want to use.

REST API Bulk API
Good for replicating Small data sets, more frequently

Note: Due to the design of Salesforce’s REST API, tracking a large number of columns in a single object can lead to replication issues. See this guide for more info.
Large data sets, less frequently

While the Bulk API allows for a greater number of tracked fields, Salesforce only allows each batch to be 5MB.
API Quota Total usage is calculated by your organization type, the type of licenses held, and the number of licenses.

Learn more about REST API quotas.
Limited to 10,000 batches per day, regardless of the standard API quota.

Learn more about Bulk API limits.
Structure Sync Uses the REST API and standard API quota. Uses the REST API and standard API quota.
Data Extraction Uses the REST API standard API quota. Uses the Bulk API and Bulk API quota. Each query to an object uses one (1) batch, even if no data is replicated from the object.

If you have any other apps using the Salesforce API, you may consume your quota more quickly.

Compound Fields Supported Unsupported by the Bulk API.

Tracking the individual fields that make up a compound field - such as street, city, state, for a compound address field - will yield the same data.
Unsupported Objects

The following objects require a querying strategy that Stitch doesn’t currently support. Read more here.

  • CollaborationGroupRecord
  • ContentDocumentLink
  • ContentFolderMember
  • DataStatistics
  • EntityParticle
  • FieldDefinition
  • FlexQueueItem
  • IdeaComment
  • OwnerChangeOptionInfo
  • PicklistValueInfo
  • PlatformAction
  • RelationshipDomain
  • RelationshipInfo
  • SearchLayout
  • UserEntityAccess
  • UserFieldAccess
  • Vote

The following objects are incompatible with querying. Read more here.

  • ActivityHistory
  • AggregateResult
  • AttachedContentDocument
  • CombinedAttachment
  • ContentBody
  • EmailStatus
  • FeedLike
  • FeedTrackedChange
  • FeedSignal
  • FolderedContentDocument
  • ListViewChartInstance
  • LookedUpFromActivity
  • Name
  • NoteAndAttachment
  • OpenActivity
  • OutgoingEmail
  • OutgoingEmailRelation
  • OwnedContentDocument
  • ProcessInstanceHistory
  • UserRecordAccess

In addition to the objects listed in the REST API column, the objects listed below are also unsupported by the Bulk API. Read more here.

  • AcceptedEventRelation
  • AssetTokenEvent
  • AttachedContentNote
  • CaseStatus
  • ContentFolderItem
  • ContractStatus
  • DeclinedEventRelation
  • EventWhoRelation
  • PartnerRole
  • QuoteTemplateRichTextData
  • RecentlyViewed
  • SolutionStatus
  • TaskPriority
  • TaskWhoRelation
  • TaskStatus
  • UndecidedEventRelation

Step 3.2: Define standard API quota usage limits

Next, you’ll define the percentage of your standard API quota Stitch is allowed to use. If these limits are reached, Stitch will pause replication and resume when additional quota becomes available.

Before defining these limits, we recommend reviewing your overall API usage in Salesforce to ensure Stitch or other apps won’t be negatively impacted. This Salesforce community topic can help you locate your current API quota and usage.

Description Example
Max Percentage of
total standard API quota
The percentage of your total API quota Stitch is allowed to use per 24 hour period.

Note: This includes API usage from other apps.
If set to 80% and the quota is 10,000 calls 24 hour period:

10,000 x .8 = 8,000

Stitch will replicate data up until 8,000 calls are used across all your connected apps.
Max Percentage of
standard API quota per job
The percentage of your total standard API quota Stitch is allowed to use per replication job. If set to 10% and the quota is 10,000 calls:

10,000 x .1 = 1,000

Stitch will use up to 1,000 calls per replication job.

Once you know what you want Stitch’s maximum allowed standard API percentages to be, enter them as whole numbers (ex: 80 for 80%) into their respective fields.

Step 4: Define new field selection

By default, when new fields are added to Salesforce objects, Stitch will automatically detect and begin replicating data from them.

If you prefer to track new fields manually, uncheck the Replicate new fields automatically checkbox. Note: This setting cannot be changed after the integration is saved.

Step 5: Define the Historical Sync

The Sync Historical Data setting will define the starting date for your Salesforce integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Salesforce’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 6: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Stitch offers two methods of creating a replication schedule:

  • Replication Frequency: This method requires selecting the interval you want replication to run for the integration. Start times of replication jobs are based on the start time and duration of the previous job. Refer to the Replication Frequency documentation for more information and examples.
  • Anchor scheduling: Based on the Replication Frequency, or interval, you select, this method “anchors” the start times of this integration’s replication jobs to a time you select to create a predictable schedule. Anchor scheduling is a combination of the Anchor Time and Replication Frequency settings, which must both be defined to use this method. Additionally, note that:

    • A Replication Frequency of at least one hour is required to use anchor scheduling.
    • An initial replication job may not begin immediately after saving the integration, depending on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

To help prevent overages, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 7: Authorize Stitch to access Salesforce

  1. Next, you’ll be prompted to sign into your Salesforce account.
  2. A screen asking for authorization to Salesforce will display. Note that Stitch will only ever read your data.
  3. Click Allow.
  4. After the authorization process successfully completes, you’ll be redirected back to Stitch.
  5. Click All Done.

Step 8: Set tables to replicate

To complete the setup, you’ll need to select tables you want to replicate to your data warehouse.

Check out the Schema section to learn more about the available tables in Salesforce and how they replicate.

  1. In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.

  3. Repeat this process for all the tables you want to replicate.
  4. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.

Initial and historical replication jobs

After you finish setting up Salesforce, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.


Salesforce table schemas

Stitch currently supports the replication of the majority of Salesforce objects, with the exception of those listed in the Unsupported Objects row of this table.

To ensure we can provide you with up-to-date docs, this section will only cover a few of the most popular tables Stitch’s Salesforce integration offers.

See the Salesforce Object Reference guide for info on objects not listed here, including the fields available in each object.

Custom Salesforce object and field replication

Stitch’s Salesforce integration supports the replication of custom objects and fields.

Custom object and field names are appended with __c to make identification easier. For example: AE_Assignment__c or Assignment_Group_Name__c


account

Replication Method: Key-based Incremental Replication Key : systemModStamp
Primary Key : id Documentation: Official Docs

The account table contains info about the individual accounts (organizations and persons) involved with your business. This could be a customer, a competitor, a partner, and so on.

id
STRING

The account ID.

systemModStamp
DATE-TIME

The time when a user or automated process (ex: a trigger) last modified the account.

accountNumber
STRING

The account number assigned to this account.

accountSource
STRING

The source of the account record. For example: Trade Show

annualRevenue
NUMBER

The estimated annual revenue of the account.

billingAddress
STRING

The compound form of the account’s billing address. Only available if using the REST API.

If using the Bulk API, track the following fields to replicate the same data:

  • billingStreet
  • billingCity
  • billingState
  • billingStateCode
  • billingCountry
  • billingCountryCode
  • billingPostalCode
  • billingLatitude
  • billingLongitude
  • billingGeocodeAccuracy
billingCity
STRING

The account’s billing city.

billingCountry
STRING

The account’s billing country.

billingCountryCode
STRING

The ISO country code for the account’s billing address.

billingGeocodeAccuracy
STRING

The compound form of the accuracy level of the geocode for the account’s billing address.

billingLatitude
INTEGER

Used with billingLongitude to specify the precise geolocation of a billing address.

billingLongitude
INTEGER

Used with billingLatitude to specify the precise geolocation of a billing address.

billingPostalCode
STRING

The postal code for the account’s billing address.

billingState
STRING

The state for the account’s billing address.

billingStateCode
STRING

The ISO state code for the account’s billing address.

billingStreet
STRING

The street address for the account’s billing address.

cleanStatus
STRING

The account’s clean status as compared with Data.com. Possible values are:

  • Matched
  • Different
  • Acknowledged
  • NotFound
  • Inactive
  • Pending
  • SelectMatch
  • Skipped
connectionReceivedId
STRING

The ID of the PartnerNetworkConnection that shared the account record with your organization. Only available if Salesforce to Salesforce is enabled.

description
STRING

The description of the account.

dunsNumber
STRING

The Data Universal Numbering System (DUNS) number associated with the account. Only available if using Data.com Prospector or Data.com Clean.

fax
STRING

The fax number associated with the account.

industry
STRING

The industry associated with the account.

isCustomerPortal
BOOLEAN

Indicates whether the account has at least one contact enabled to use the organization’s Customer Portal. This field will be true if at least one contact is enabled to use the portal. Only available if Customer Portal or Communities is enabled and there are Customer Portal licenses.

isDeleted
BOOLEAN

Indicates if the account has been moved to the Recycle Bin (true) or not (false).

isPartner
BOOLEAN

Indicates whether the account has at least one contact enabled to use the organization’s partner portal (true) or not (false). Only available if Partner Portal or Communities is enabled and there are partner portal licenses.

isPersonAccount
BOOLEAN

Indicates if the account has a record type of Person Account (true) or not (false). Refer to Salesforce’s documentation for info on the additional fields associated with this record type.

jigsaw
STRING

The account’s ID from Data.com. If an account has a value in this field, it means that the account was imported from Data.com.

lastActivityDate
DATE-TIME

The due date of the most recently logged event OR the most recently closed task associated with the account, whichever is more recent.

lastReferenceDate
DATE-TIME

The date a record associated with the account was last viewed.

lastViewedDate
DATE-TIME

The date the account was last viewed.

masterRecordId
STRING

If the account was deleted as the result of a merge, this field will contain the ID of the record that was kept.

If this account was deleted for any other reason (or hasn’t been deleted), the value will be NULL.

naicsCode
STRING

The North American Industry Classification System (NAICS) code associated with the account. Only available if using Data.com Prospector or Data.com Clean.

naicsDescription
STRING

The description associated with the account’s NAICS code. Only available if using Data.com Prospector or Data.com Clean.

name
STRING

The name of the account.

If the account’s record type is PersonAccount, the value of this field will be a concatenation of the FirstName, MiddleName, LastName, and Suffix fields of the associated person contact.

name
STRING

The name of the account.

If the account’s record type is PersonAccount, the value of this field will be a concatenation of the firstName, middleName, lastName, and suffix fields of the associated person contact. Only available if using the REST API.

numberOfEmployees
NUMBER

The number of employees working at the company represented by the account.

operatingHoursId
STRING

The operating hours associated with the account. Only available if Field Service Lightning is enabled.

ownerId
STRING

The ID of the user who currently owns the account.

ownership
STRING

The ownership type for the account. For example: Private

parentId
STRING

The ID of the account’s parent object, if applicable.

phone
STRING

The phone number associated with the account.

photoUrl
STRING

The path to be combined with the URL of a Salesforce instance to generate a URL to request the social network profile image associated with the account.

This field will be blank if Social Accounts and Contacts aren’t enabled for the organization or requesting user.

rating
STRING

The account’s prospect rating. For example: Cold

recordTypeId
STRING

The ID of the record type assigned to the account.

salutation
STRING

The honorific added to the name for use in letters, etc.

shippingAddress
STRING

The compound form of the account’s shipping address. Only available if using the REST API.

If using the Bulk API, track the following fields to replicate the same data:

  • shippingStreet
  • shippingCity
  • shippingState
  • shippingStateCode
  • shippingCountry
  • shippingCountryCode
  • shippingPostalCode
  • shippingLatitude
  • shippingLongitude
  • shippingGeocodeAccuracy
shippingCity
STRING

The account’s shipping city.

shippingCountry
STRING

The account’s shipping country.

shippingCountryCode
STRING

The ISO country code for the account’s shipping address.

shippingGeocodeAccuracy
STRING

The compound form of the accuracy level of the geocode for the account’s shipping address.

shippingLatitude
INTEGER

Used with shippingLongitude to specify the precise geolocation of a shipping address.

shippingLongitude
INTEGER

Used with shippingLatitude to specify the precise geolocation of a shipping address.

shippingPostalCode
STRING

The postal code for the account’s shipping address.

shippingState
STRING

The state for the account’s shipping address.

shippingStateCode
STRING

The ISO state code for the account’s shipping address.

shippingStreet
STRING

The street address for the account’s shipping address.

sic
STRING

The Standard Industrial Classification code of the company’s main business organization.

sicDesc
STRING

The description associated with the account’s SIC code.

site
STRING

The name of the account’s location. For example: Philadelphia or Main Office

tickerSymbol
STRING

The stock market symbol associated with the account.

tradeStyle
STRING

Similar to doing business as, this is the name (different from its legal name), that the organization may use for conducting business. Only available if using Data.com Prospector or Data.com Clean.

type
STRING

The type of the account. For example: Customer

website
STRING

The website associated with the account.

yearStarted
STRING

The date when the account (organization) was legally established. Only available if using Data.com Prospector or Data.com Clean.


contact

Replication Method: Key-based Incremental Replication Key : systemModStamp
Primary Key : id Documentation: Official Docs

The contact table contains info about your contacts, who are individuals associated with accounts in your Salesforce instance.

id
STRING

The contact ID.

systemModStamp
DATE-TIME

The time when a user or automated process (ex: a trigger) last modified the contact.

accountId
STRING

The ID of the account that is the parent of the contact.

assistantName
STRING

The name of the assistant.

assistantPhone
STRING

The phone number associated with the contact.

birthdate
DATE

The birthdate of the contact.

canAllowPortalSelfReg
BOOLEAN

Indicates if the contact can self-register for your organization’s Customer Portal (true) or not (false).

cleanStatus
STRING

The contact’s clean status as compared with Data.com. Possible values are:

  • Matched
  • Different
  • Acknowledged
  • NotFound
  • Inactive
  • Pending
  • SelectMatch
  • Skipped
connectionReceivedId
STRING

The ID of the PartnerNetworkConnection that shared the contact record with your organization. Only available if Salesforce to Salesforce is enabled.

connectionSentId
STRING

The ID of the PartnerNetworkConnection that you shared the contact record with. Deprecated by Salesforce.

department
STRING

The department of the contact.

description
STRING

The description of the contact.

doNotCall
BOOLEAN

Indicates if the contact does not want to be called (true).

email
STRING

The email address associated with the contact.

emailBouncedDate
DATE-TIME

If bounce management is activated and an email sent to the contact bounces, the date and time the bounce occurred.

emailBouncedReason
STRING

If bounce management is activated and an email sent to the contact bounces, the reason the bounce occurred.

fax
STRING

The fax number associated with the contact.

firstName
STRING

The first name of the contact.

hasOptedOutOfEmail
BOOLEAN

Indicates if the contact would prefer not to receive email from Salesforce (true) or not (false).

hasOptedOutOfFax
BOOLEAN

Indicates if the contact would prefer not to receive faxes (true) or not (false).

homePhone
STRING

The home phone number associated with the contact.

isDeleted
BOOLEAN

Indicates if the contact has been moved to the Recycle Bin (true) or not (false).

isEmailBounced
BOOLEAN

If bounce management is activated and an email is sent to a contact, indicates if the email bounced (true) or not (false).

isPersonAccount
BOOLEAN

Indicates if the contact has a record type of Person Account (true) or not (false). Refer to Salesforce’s documentation for info on the additional fields associated with this record type.

jigsaw
STRING

The contact’s ID from Data.com. If a contact has a value in this field, it means that the contact was imported from Data.com.

lastActivityDate
DATE-TIME

The due date of the most recently logged event OR the most recently closed task associated with the contact, whichever is more recent.

lastName
STRING

The last name of the contact.

lastReferenceDate
DATE-TIME

The date a record associated with the contact was last viewed.

lastViewedDate
DATE-TIME

The date the contact was last viewed.

leadSource
STRING

The source of the lead.

mailingAddress
STRING

The compound form of the contact’s mailing address. Only available if using the REST API.

If using the Bulk API, track the following fields to replicate the same data:

  • mailingStreet
  • mailingCity
  • mailingState
  • mailingStateCode
  • mailingCountry
  • mailingCountryCode
  • mailingPostalCode
  • mailingLatitude
  • mailingLongitude
  • mailingGeocodeAccuracy
mailingCity
STRING

The contact’s mailing city.

mailingCountry
STRING

The contact’s mailing country.

mailingCountryCode
STRING

The ISO country code for the contact’s mailing address.

mailingGeocodeAccuracy
STRING

The compound form of the accuracy level of the geocode for the contact’s mailing address.

mailingLatitude
INTEGER

Used with mailingLongitude to specify the precise geolocation of a mailing address.

mailingLongitude
INTEGER

Used with mailingLatitude to specify the precise geolocation of a mailing address.

mailingPostalCode
STRING

The postal code for the contact’s mailing address.

mailingState
STRING

The state for the contact’s mailing address.

mailingStateCode
STRING

The ISO state code for the contact’s mailing address.

mailingStreet
STRING

The street address for the contact’s mailing address.

masterRecordId
STRING

If the contact was deleted as the result of a merge, this field will contain the ID of the record that was kept.

If this contact was deleted for any other reason (or hasn’t been deleted), the value will be NULL.

middleName
STRING

The middle name of the contact.

mobilePhone
STRING

The mobile phone number associated with the contact.

name
STRING

The concatenation of firstName, middleName, lastName, and suffix. Only available if using the REST API.

If using the Bulk API, track the following fields to replicate the same data:

  • firstName
  • middleName
  • lastName
  • suffix
otherAddress
STRING

The compound form of the contact’s alternate address. Only available if using the REST API.

If using the Bulk API, track the following fields to replicate the same data:

  • otherStreet
  • otherCity
  • otherState
  • otherStateCode
  • otherCountry
  • otherCountryCode
  • otherPostalCode
  • otherLatitude
  • otherLongitude
  • otherGeocodeAccuracy
otherCity
STRING

The contact’s alternate city.

otherCountry
STRING

The contact’s alternate country.

otherCountryCode
STRING

The ISO country code for the contact’s alternate address.

otherGeocodeAccuracy
STRING

The compound form of the accuracy level of the geocode for the contact’s alternate address.

otherLatitude
INTEGER

Used with otherLongitude to specify the precise geolocation of the contact’s alternate address.

otherLongitude
INTEGER

Used with otherLatitude to specify the precise geolocation of the contact’s alternate address.

otherPostalCode
STRING

The postal code for the contact’s alternate address.

otherState
STRING

The state for the contact’s alternate address.

otherStateCode
STRING

The ISO state code for the contact’s alternate address.

otherStreet
STRING

The street address for the contact’s alternate address.

otherPhone
STRING

The phone number associated with the contact’s alternate address.

ownerId
STRING

The ID of the owner of the account associated with the contact.

phone
STRING

The phone number associated with the contact.

photoUrl
STRING

The path to be combined with the URL of a Salesforce instance to generate a URL to request the social network profile image associated with the contact.

This field will be blank if Social Accounts and Contacts aren’t enabled for the organization or requesting user.

recordTypeId
STRING

The ID of the record type assigned to the contact.

reportsToId
STRING

If isPersonAccount is true, this field will be NULL.

salutation
STRING

The honorific added to the contact’s name for use in letters, etc.

suffix
STRING

The name suffix of the contact.

title
STRING

The title of the contact. For example: CEO, Director of Product, etc.


lead

Replication Method: Key-based Incremental Replication Key : systemModStamp
Primary Key : id Documentation: Official Docs

The lead table contains info about your leads, who are prospects or potential Opportunities.

id
STRING

The lead ID.

systemModStamp
DATE-TIME

The time when a user or automated process (ex: a trigger) last modified the lead.

address
STRING

The compound form of the lead’s address. Only available if using the REST API.

If using the Bulk API, track the following fields to replicate the same data:

  • street
  • city
  • state
  • stateCode
  • country
  • countryCode
  • postalCode
  • latitude
  • longitude
  • geocodeAccuracy
annualRevenue
NUMBER

The estimated annual revenue for the lead’s company.

city
STRING

The city for the address of the lead.

cleanStatus
STRING

The lead’s clean status as compared with Data.com. Possible values are:

  • Matched
  • Different
  • Acknowledged
  • NotFound
  • Inactive
  • Pending
  • SelectMatch
  • Skipped
company
STRING

The company associated with the lead.

companyDunsNumber
STRING

The Data Universal Numbering System (DUNS) number associated with the lead’s company. Only available if using Data.com Prospector or Data.com Clean.

connectionReceivedId
STRING

The ID of the PartnerNetworkConnection that shared the lead record with your organization. Only available if Salesforce to Salesforce is enabled.

convertedAccountId
STRING

The reference ID that points to the Account into which the lead has been converted.

convertedContactId
STRING

The reference ID that points to the Contact into which the lead has been converted.

convertedDate
DATE-TIME

The date on which the lead was converted.

convertedOpportunityId
STRING

The reference ID that points to the Opportunity into which the lead has been converted.

country
STRING

The country for the address of the lead.

countryCode
STRING

The ISO country code for the lead’s address.

currencyIsoCode
STRING

The ISO code for any currency allowed by the organization. Only available for organizations with the multicurrency feature enabled.

description
STRING

The description of the lead.

division
STRING

The logical segment of your organization’s data. For example: North America, Consulting, Operations. Only available if the organization has the Division permission enabled.

email
STRING

The email address associated with the lead.

emailBouncedDate
DATE-TIME

If bounce management is activated and an email sent to the lead bounces, the date and time the bounce occurred.

emailBouncedReason
STRING

If bounce management is activated and an email sent to the lead bounces, the reason the bounce occurred.

fax
STRING

The fax number associated with the lead.

firstName
STRING

The first name of the lead.

hasOptedOutOfEmail
BOOLEAN

Indicates if the lead would prefer not to receive email from Salesforce (true) or not (false).

geocodeAccuracy
STRING

The compound form of the accuracy level of the geocode for the lead’s address.

industry
STRING

The industry the lead works in.

isConverted
BOOLEAN

Indicates if the lead has been converted (true) or not (false).

isDeleted
BOOLEAN

Indicates if the lead has been moved to the Recycle Bin (true) or not (false).

isUnreadByOwner
BOOLEAN

If true, the lead has been assigned but not yet viewed.

jigsaw
STRING

The lead’s ID from Data.com. If a lead has a value in this field, it means that the contact was imported from Data.com.

lastActivityDate
DATE-TIME

The due date of the most recently logged event OR the most recently closed task associated with the lead, whichever is more recent.

lastName
STRING

The last name of the lead.

lastReferenceDate
DATE-TIME

The date a record associated with the lead was last viewed.

lastViewedDate
DATE-TIME

The date the lead was last viewed.

latitude
INTEGER

Used with Longitude to specify the precise geolocation of a address.

longitude
INTEGER

Used with Latitude to specify the precise geolocation of a address.

leadSource
STRING

The source from which the lead was obtained.

masterRecordId
STRING

If the lead was deleted as the result of a merge, this field will contain the ID of the record that was kept.

If this lead was deleted for any other reason (or hasn’t been deleted), the value will be NULL.

middleName
STRING

The middle name of the lead.

mobilePhone
STRING

The mobile phone number associated with the lead.

name
STRING

The concatenation of firstName, middleName, lastName, and suffix. Only available if using the REST API.

If using the Bulk API, track the following fields to replicate the same data:

  • firstName
  • middleName
  • lastName
  • suffix
numberOfEmployees
INTEGER

The number of employees at the lead’s company.

ownerId
STRING

The ID of the owner of the lead.

partnerAccountId
STRING

The ID of the partner account for the partner that owns the lead. Only available if Partner Relationship Management is enabled or Communities is enabled and you have partner licenses.

phone
STRING

The phone number associated with the lead.

photoUrl
STRING

The path to be combined with the URL of a Salesforce instance to generate a URL to request the social network profile image associated with the lead.

This field will be blank if Social Accounts and Contacts aren’t enabled for the organization or requesting user.

PostalCode
STRING

The postal code for the lead’s address.

rating
STRING

The rating of the lead.

recordTypeId
STRING

The ID of the record type assigned to the lead.

salutation
STRING

The salutation of the lead.

scoreIntelligenceId
STRING

The ID of the intelligent field record that contains the lead score.

state
STRING

The state for the lead’s address.

stateCode
STRING

The ISO state code for the lead’s address.

status
STRING

The status code of the converted lead.

street
STRING

The street address for the lead’s address.

suffix
STRING

The name suffix of the lead.

title
STRING

The title of the lead. For example: CEO, Director of Product, etc.

website
STRING

The website for the lead.


opportunity

Replication Method: Key-based Incremental Replication Key : systemModStamp
Primary Key : id Documentation: Official Docs

The opportunity table contains info about your opportunities, which are sales or pending deals.

id
STRING

The opportunity ID.

systemModStamp
DATE-TIME

The time when a user or automated process (ex: a trigger) last modified the opportunity.

accountId
STRING

The ID of the account associated with the opportunity.

amount
NUMBER

The estimated total sale amount. For opportunities with products, the amount will be the total sum of the related products.

campaignId
STRING

The ID of a related campaign. Only defined for organizations where the campaign feature is enabled.

closeDate
DATE-TIME

The date the opportunity is expected to close.

connectionReceivedId
STRING

The ID of the PartnerNetworkConnection that shared the opportunity record with your organization. Only available if Salesforce to Salesforce is enabled.

connectionSentId
STRING

The ID of the PartnerNetworkConnection that you shared the opportunity record with. Deprecated by Salesforce.

currencyIsoCode
STRING

The ISO code for any currency allowed by the organization. Only available for organizations with the multicurrency feature enabled.

description
STRING

The description of the opportunity.

expectedRevenue
NUMBER

Amount equal to the product of the opportunity amount field and the probability.

fiscal
STRING

The name of the fiscal quarter or period in which the opportunity closeDate falls. Applicable if fiscal years are not enabled.

fiscalQuarter
INTEGER

The numerical representation of the fiscal quarter. Possible values are 1, 2, 3, or 4.

fiscalYear
INTEGER

The fiscal year.

forecastCategory
STRING

The forecast category for the opportunity.

forecastCategoryName
STRING

The name of the forecast category for the opportunity.

hasOpenActivity
BOOLEAN

Indicates if the opportunity has associated line items (true) or not (false).

hasOpportunityLineItem
BOOLEAN

Indicates if the opportunity has an open event (true) or not (false). Opportunities can have opportunity line items only if the opportunity has a price book.

hasOverdueTask
BOOLEAN

Indicates if an opportunity has an overdue task (true) or not (false).

isClosed
BOOLEAN

Indicates if the opportunity is closed (true) or not (false).

isDeleted
BOOLEAN

Indicates if the opportunity has been moved to the Recycle Bin (true) or not (false).

isExcludedFromTerritory2Filter
BOOLEAN

Indicates if the opportunity is exclued (true) or included (false) each time the APEX filter is executed.

isSplit
BOOLEAN

Indicates whether credit for the opportunity is split between team members (true) or not (false).

isWon
BOOLEAN

Indicates if the opportunity is won (true) or not (false).

lastActivityDate
DATE-TIME

The due date of the most recently logged event OR the most recently closed task associated with the opportunity, whichever is more recent.

lastReferenceDate
DATE-TIME

The date a record associated with the opportunity was last viewed.

lastViewedDate
DATE-TIME

The date the opportunity was last viewed.

leadSource
STRING

The source from which the opportunity was obtained. For example: Advertisement, Trade Show

name
STRING

The name of the opportunity.

nextStep
STRING

The description of the next task in closing the opportunity.

ownerId
STRING

The ID of the user who has been assigned to work the opportunity.

pricebook2Id
STRING

The ID of the related Pricebook2 object. Only available if the products feature is enabled for an organization.

pricebookId
STRING

The ID of the related Pricebook object. Deprecated by Salesforce.

probability
INTEGER

The percentage of estimated confidence in closing the opportunity.

recordTypeId
STRING

The ID of the record type assigned to the opportunity.

stageName
STRING

The current stage of the opportunity.

syncedQuoteId
STRING

The ID of the quote that syncs with the opportunity.

territory2Id
STRING

The ID of the territory assigned to the opportunity. Only available if Enterprise Territory Management is enabled.

totalOpportunityQuantity
NUMBER

The number of items included in the opportunity.

type
STRING

The type of opportunity. For example: Existing Business


user

Replication Method: Key-based Incremental Replication Key : systemModStamp
Primary Key : id Documentation: Official Docs

The user table contains info about the users in your organization.

id
STRING

The user ID.

systemModStamp
DATE-TIME

The time when a user or automated process (ex: a trigger) last modified the user.

aboutMe
STRING

Information about the user, such as areas of interest or skills.

accountId
STRING

The ID of the account associated with a Customer Portal user. This field will be NULL for Salesforce users.

address
STRING

The compound form of the lead’s address. Only available if using the REST API.

If using the Bulk API, track the following fields to replicate the same data:

  • street
  • city
  • state
  • stateCode
  • country
  • countryCode
  • postalCode
  • latitude
  • longitude
  • geocodeAccuracy
alias
STRING

The user’s alias.

badgeText
STRING

The text description of a user badge that appears over the user’s photo.

bannerPhotoUrl
STRING

The URL for the user’s banner photo.

callCenterId
STRING

The call center to which the user is assigned. Only available if Salesforce CRM Call Center is enabled.

city
STRING

The city associated with the user.

communityNickname
STRING

The name used to identify this user in the Community application, which includes the ideas and answers features.

companyName
STRING

The name of the user’s company.

contactId
STRING

The ID of the contact associated with the account.

country
STRING

The country associated with the user.

countryCode
STRING

The ISO country code associated with the user.

defaultCurrencyIsoCode
STRING

The user’s default currency setting for new records.

defaultDivision
STRING

The user’s default division. Only applicable if divisions are enabled.

defaultGroupNotificationFrequency
STRING

The default frequency for sending the user’s Chatter group email notifications when the user joins groups. Possible values are:

  • P - Email on every post
  • D - Daily digests
  • W - Weekly digests
  • N - Never
delegatedApproverId
STRING

The ID of the user who is a delegated approver for the user.

department
STRING

The company department associated with the user.

digestFrequency
STRING

The frequency at which the system sends the user’s Chatter personal digest. Possible values are:

  • D - Daily
  • W - Weekly
  • N - Never
division
STRING

The division associated with the user. This is similar to department and unrelated to defaultDivision.

email
STRING

The email address associated with the user.

emailEncodingKey
STRING

The email encoding for the user, such as ISO-8859- or UTF-8.

emailPreferencesAutoBcc
BOOLEAN

Indicates if the user receives copies of sent emails (true) or not (false). Only applicable if compliance BCC emails aren’t enabled.

employeeNumber
STRING

The user’s employee number.

extension
STRING

The user’s phone extension number.

fax
STRING

The fax number associated with the user.

federationIdentifier
STRING

The value that must be listed in the Subject element of a Security Assertion Markup Language (SAML) IDP certificate to authenticate the user for a client application using single-on.

firstName
STRING

The user’s first name.

forecastEnabled
BOOLEAN

Indicates if the user is enabled as a Forecast Manager (true) or not (false) in customizable forecasting.

fullPhotoUrl
STRING

The URL for the user’s current profile photo.

isActive
BOOLEAN

Indicates if the user has access to log in (true) or not (false).

isPortalEnabled
BOOLEAN

Indicates if the user has access to Communities or portals (true) or not (false).

isPortalSelfRegistered
BOOLEAN

Indicates if the user is a Customer Portal user who self-registered for your organization’s Customer Portal (true) or not (false).

isPrmSuperUser
BOOLEAN

Indicates if the user has super user access in the partner portal (true) or (false). This field must be enabled by Salesforce.

isProfilePhotoActive
BOOLEAN

Indicates if the user has a profile photo (true) or not (false).

jigsawImportLimitOverride
INTEGER

The Data.com user’s monthly addition limit.

languageLocaleKey
STRING

The user’s language. For example: English or French

lastLoginDate
DATE-TIME

The date and time when the user last successfully logged in.

lastName
STRING

The user’s last name.

lastReferenceDate
DATE-TIME

The date a record associated with the lead was last viewed.

lastViewedDate
DATE-TIME

The date the lead was last viewed.

latitude
INTEGER

Used with Longitude to specify the precise geolocation of a address.

localeSidKey
STRING
longitude
INTEGER

Used with Latitude to specify the precise geolocation of a address.

manager
STRING

The user’s manager.

managerId
STRING

The ID of the user who manages the user.

mediumBannerPhotoUrl
STRING

The URL for the user’s medium-sized user profile banner photo.

middleName
STRING

The user’s middle name. This field must be enabled by Salesforce.

mobilePhone
STRING

The mobile phone number associated with the user.

name
STRING

The concatenation of firstName and lastName. Only available if using the REST API.

If using the Bulk API, track the firstName and lastName fields to replicate the same data.

offlineTrialExpirationDate
DATE-TIME

The date and time when the user’s Connect Offline trial expires.

phone
STRING

The phone number associated with the user.

portalRole
STRING

The role of the user in the Customer Portal. Possible values are:

  • Executive
  • Manager
  • User
  • PersonAccount

Only available if Customer Portal is enabled or Communities is enabled and there are available partner portal, Customer Portal, or High-Volume Portal User licenses.

postalCode
STRING

The user’s postal or ZIP code.

profileId
STRING

The ID of the user’s profile.

receivesAdminInfoEmails
BOOLEAN

Indicates if the user receives email for administrators from Salesforce (true) or not (false).

receivesInfoEmails
BOOLEAN

Indicates if the user receives informational email from Salesforce (true) or not (false).

senderEmail
STRING

The From email address when the user sends email.

senderName
STRING

The name used as the email sender when the user sends emails.

signature
STRING

The signature text added to emails.

smallBannerPhotoUrl
STRING

The URL for the user’s small user profile banner photo.

smallPhotoUrl
STRING

The URL for the thumbnail of the user’s current profile photo.

state
STRING

The state associated with the user.

stateCode
STRING

The ISO state code of the state associated with the user.

street
STRING

The street address for the lead’s address.

suffix
STRING

The name suffix of the lead.

timeZoneSidKey
STRING
title
STRING

The business title of the user. For example: CEO, Director of Product, etc.

username
STRING

The name the user enters to log into the API or user interface.

userPermissionsCallCenterAutoLogin
BOOLEAN

Indicates if the user is enabled to use the auto login feature of the call center (true) or not (false). Only applicable if Salesforce CRM Call Center is enabled.

userPermissionsChatterAnswersUser
BOOLEAN

Indicates if the portal user is enabled to use the Chatter Answers feature (true) or not (false).

userPermissionsInteractionUser
BOOLEAN

Indicates if the user can run flows (true) or not (false).

userPermissionsJigsawProspectingUser
BOOLEAN

Indicates if the user is allocated one Data.com user license (true) or not (false).

userPermissionsKnowledgeUser
BOOLEAN

Indicates if the user is enabled to use Salesforce Knowledge (true) or not (false).

userPermissionsLiveAgentUser
BOOLEAN

Indicates if the user is enabled to use Live Agent (true) or not (false).

userPermissionsMarketingUser
BOOLEAN

Indicates if the user is enabled to manage campaigns in the user interface (true) or not (false).

userPermissionsMobileUser
BOOLEAN

Indicates if the user is allocated one Salesforce Mobile Classic license (true) or not (false).

userPermissionsOfflineUser
BOOLEAN

Indicates if the user is enabled to use Offline Edition (true) or not (false).

userPermissionsSFContentUser
BOOLEAN

Indicates if the user is allocated one Salesforce CRM Content User license (true) or not (false).

userPermissionsSiteforceContributorUser
BOOLEAN

Indicates if the user is allocated one Site.com Contributor feature license (true) or not (false).

userPermissionsSiteforcePublisherUser
BOOLEAN

Indicates if the user is allocated one Site.com Publisher feature license (true) or not (false).

userPermissionsSupportUser
BOOLEAN

Indicates if the user is enabled to use the Salesforce console (true) or not (false).

userPermissionsWorkDotComeUserFeature
BOOLEAN

Indicates if the Work.com feature is enabled for the user (true) or not (false).

userPreferencesAcitivityRemindersPopup
BOOLEAN

When true, a reminder popup window will automatically open when an activity reminder is due for the user.

userPreferencesApexPagesDeveloperMode
BOOLEAN

When true, indicates the user has enabled developer mode for editing Visualforce pages and controllers.

userPreferencesContentEmailAsAndWhen
BOOLEAN

When false, a user with Salesforce CRM Content subscriptions receives a once daily email summary if activity occurs on their subscribed content, libraries, tags, or authors.

userPreferencesContentNoEmail
BOOLEAN

When false, a user with Salesforce CRM Content subscriptions receives email notifications if activity occurs on their subscribed content, libraries, tags, or authors.

userPreferencesEnableAutoSubForFeeds
BOOLEAN

When true, the user automatically subscribes to feeds for any objects that the user creates.

userPreferencesDisableAllFeedsEmail
BOOLEAN

When false, the user automatically receives email for all updates to Chatter feeds, based on the types of feed emails and digests the user has enabled.

userPreferencesDisableBookmarkEmail
BOOLEAN

When false, the user automatically receives email every time someone comments on a Chatter feed item after the user bookmarks it.

userPreferencesDisableChangeCommentEmail
BOOLEAN

When false, the user automatically receives email every time someone comments on a change the user has made. For example: an update to their profile.

userPreferencesDisableEndorsementEmail
BOOLEAN

When false, the user automatically receives email every time someone endorses them for a topic.

userPreferencesDisableFileShareNotificationsForApi
BOOLEAN

When false, email notifications are sent from the person who has shared a file to the users with whom the file has been shared.

userPreferencesDisableFollowersEmail
BOOLEAN

When false, the user will automatically receive an email every time someone starts following the user in Chatter.

userPreferencesDisableLaterCommentEmail
BOOLEAN

When false, the user automatically receives an email every time someone comments on a feed item after the user has commented on a feed item.

userPreferencesDisableLikeEmail
BOOLEAN

When false, the user automatically receives email every time someone likes a post or comment the user made.

userPreferencesDisableMentionsPostEmail
BOOLEAN

When false, the user automatically receives email every time the user is mentioned in posts.

userPreferencesDisableMentionsPostEmail
BOOLEAN

When false, the user automatically receives email every time the user is mentioned in a post.

userPreferencesDisableProfilePostEmail
BOOLEAN

When false, the user automatically receives email every time someone posts to the users profile.

userPreferencesDisableSharePostEmail
BOOLEAN

When false, the user automatically receives email every time the user’s post is shared.

userPreferencesDisableFeedbackEmail
BOOLEAN

When false, the user automatically receives email related to Work.com feedback.

userPreferencesDisCommentAfterLikeEmail
BOOLEAN

When false, the user automatically receives email every time someone comments on a post the user has liked.

userPreferencesDisMentionsCommentEmail
BOOLEAN

When false, the user automatically receives email every time the user is mentioned in a comment.

userPreferencesDisableMessageEmail
BOOLEAN

When false, the user automatically receives email for Chatter messages sent to the user.

userPreferencesDisableRewardEmail
BOOLEAN

When false, the user automatically receives email related to Work.com rewards.

userPreferencesDisableWorkEmail
BOOLEAN

When false, the user automatically receives emails related to Work.com feedback, goals, and coaching.

userPreferencesDisProfPostCommentEmail
BOOLEAN

When false, the user automatically receives email every time someone comments on posts on the user’s profile.

userPreferencesEventRemindersCheckboxDefault
BOOLEAN

When true, a reminder popup is automatically set on the user’s events.

userPreferencesHideBiggerPhotoCallout
BOOLEAN

When true, users can choose to hide the callout text below the large profile photo.

userPreferencesHideChatterOnboardingSplash
BOOLEAN

When true, the initial Chatter onboarding prompts won’t appear for the user.

userPreferencesHideCSNDesktopTask
BOOLEAN

When true, the Chatter recommendations panel never displays the recommendation to install Chatter Desktop for the user.

userPreferencesHideCSNGetChatterMobileTask
BOOLEAN

When true, the Chatter recommendations panel never displays the recommendation to install Chatter Mobile for the user.

userPreferencesHideHideSecondChatterOnboardingSplash
BOOLEAN

When true, the secondary Chatter onboarding prompts won’t appear for the user.

userPreferencesHideS1BrowserUI
BOOLEAN

When true, the user will see the full Salesforce site. If false, the user will be automatically redirected to the Salesforce mobile web.

userPreferencesHideSfxWelcomeMat
BOOLEAN

Indicates if the user sees the Lightning Experience new user message (true) or not (false).

userPreferencesJigsawListUser
BOOLEAN

When true, the user is a Data.com List user and shares record additions from a pool.

userPreferencesLightningExperiencePreferred
BOOLEAN

When true, the user will be redirected to the Lighting Experience Interface.

userPreferencesPathAssistantCollapsed
BOOLEAN

When true, Sales Path appears collapsed or hidden to the user.

userPreferencesReminderSoundOff
BOOLEAN

When true, a sound automatically plays when an activity reminder is due for the user.

userPreferencesShowCityToExternalUsers
BOOLEAN

When true, the city in the user’s contact info will be visible to external users.

userPreferencesShowCityToGuestUsers
BOOLEAN

When true, the city in the user’s contact info will be visible to guest users.

userPreferencesShowCountryToExternalUsers
BOOLEAN

When true, the country in the user’s contact info will be visible to external users.

userPreferencesShowCountryToGuestUsers
BOOLEAN

When true, the country in the user’s contact info will be visible to guest users.

userPreferencesShowEmailToExternalUsers
BOOLEAN

When true, the email address in the user’s contact info will be visible to external users.

userPreferencesShowEmailToGuestUsers
BOOLEAN

When true, the email address in the user’s contact info will be visible to guest users.

userPreferencesShowFaxToExternalUsers
BOOLEAN

When true, the fax number in the user’s contact info will be visible to external users.

userPreferencesShowFaxToGuestUsers
BOOLEAN

When true, the fax number in the user’s contact info will be visible to guest users.

userPreferencesShowManagerToExternalUsers
BOOLEAN

When true, the user’s manager in the user’s contact info will be visible to external users.

userPreferencesShowManagerToGuestUsers
BOOLEAN

When true, the user’s manager in the user’s contact info will be visible to guest users.

userPreferencesShowMobilePhoneToExternalUsers
BOOLEAN

When true, the mobile phone number in the user’s contact info will be visible to external users.

userPreferencesShowMobilePhoneToGuestUsers
BOOLEAN

When true, the mobile phone number in the user’s contact info will be visible to guest users.

userPreferencesShowPostalCodeToExternalUsers
BOOLEAN

When true, the postal code in the user’s contact info will be visible to external users.

userPreferencesShowPostalCodeToGuestUsers
BOOLEAN

When true, the postal code in the user’s contact info will be visible to guest users.

userPreferencesShowProfilePicToExternalUsers
BOOLEAN

When true, the user’s profile photo will be visible to external users.

userPreferencesShowProfilePicToGuestUsers
BOOLEAN

When true, the user’s profile photo will be visible to guest users.

userPreferencesShowStateToExternalUsers
BOOLEAN

When true, the state in the user’s contact info will be visible to external users.

userPreferencesShowStateToGuestUsers
BOOLEAN

When true, the state in the user’s contact info will be visible to guest users.

userPreferencesShowStreetAddressToExternalUsers
BOOLEAN

When true, the street address in the user’s contact info will be visible to external users.

userPreferencesShowStreetAddressToGuestUsers
BOOLEAN

When true, the street address in the user’s contact info will be visible to guest users.

userPreferencesShowTitleToExternalUsers
BOOLEAN

When true, the business title in the user’s contact info will be visible to external users.

userPreferencesShowTitleToGuestUsers
BOOLEAN

When true, the business title in the user’s contact info will be visible to guest users.

userPreferencesShowWorkPhoneToExternalUsers
BOOLEAN

When true, the work phone number in the user’s contact info will be visible to external users.

userPreferencesShowWorkPhoneToGuestUsers
BOOLEAN

When true, the work phone number in the user’s contact info will be visible to guest users.

userPreferencesSortFeedByComment
BOOLEAN

When true, the user’s feed is sorted by most recent comment activity. If false, the feed is sorted by post date.

userPreferencesTaskRemindersCheckboxDefault
BOOLEAN

When true, a reminder popup is automatically set on the user’s tasks.

userRoleId
STRING

The ID of the user role assigned to the user.

userType
STRING

The category of the user license allocated to the user. Possible values include:

  • Standard
  • PowerPartner
  • CSPLitePortal
  • CustomerSuccess
  • PowerCustomerSuccess
  • CsnOnly


Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.