This integration is powered by Singer's Salesforce tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
Salesforce integration summary
Stitch’s Salesforce integration replicates data from your Salesforce account. When setting up a Salesforce integration in Stitch, you can select one of the following Salesforce APIs to replicate your data:
Each API has its own advantages and disadvantages, such as support for compound fields and specific objects. Learn more in the setup guide.
Salesforce feature snapshot
A high-level look at Stitch's Salesforce (v2) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on August 17, 2023 |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Supported |
Configurable Replication Methods |
Supported |
DATA SELECTION | |||
Table selection |
Supported |
Column selection |
Supported |
Select all |
Supported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Salesforce
Salesforce setup requirements
To set up Salesforce in Stitch, you need:
-
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”.
Complete this step before proceeding with the rest of the setup, or you may encounter connection issues.
Step 1.1: Verify your Stitch account's data pipeline region
The IP addresses you’ll whitelist depend on the Data pipeline region your account is in.
- Sign into your Stitch account, if you haven’t already.
- Click User menu (your icon) > Manage Account Settings and locate the Data pipeline region section to verify your account’s region.
-
Locate the list of IP addresses for your region:
Keep this list handy - you’ll need it in the next step.
Step 1.2: Set Stitch's IP addresses as trusted IPs
Next, you’ll add the IP addresses you retrieved in the previous step to your Salesforce instance’s trusted IP list. The instructions in this Salesforce article will walk you through how to do this in Salesforce.
Note: Because Stitch’s IPs 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.
Step 2: Add Salesforce as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Salesforce icon.
-
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. - 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:
- The type of API used for data extraction (Bulk vs REST), and
- 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. Refer to Salesforce’s documentation for more info. |
Limited to 10,000 batches per day, regardless of the standard API quota. Refer to Salesforce’s documentation for more info. |
Structure sync |
Uses the REST API and standard API quota. |
Uses the Bulk API, 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 |
Tracking the individual fields that make up a compound field - such as |
Unsupported objects |
The following objects require a querying strategy that Stitch doesn’t currently support. Read more here.
The following objects are incompatible with querying. Read more here.
|
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.
|
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 Salesforce 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.
Data for new fields in already-replicating tables
Data in new fields in already-replicating tables will only be available for records added or updated after the column is tracked, whether they’re tracked manually or automatically. This is only applicable to tables using Key-based Incremental Replication.
To backfill columns - or get data for a new field into existing rows - you’ll need to queue a full re-replication of the table by resetting its Replication Key values on the Table Settings page.
Step 5: Define the historical replication start date
The Sync Historical Data setting defines 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.
Salesforce integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, 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
- Next, you’ll be prompted to sign into your Salesforce account.
- A screen asking for authorization to Salesforce will display. Note that Stitch will only ever read your data.
- Click Allow.
- After the authorization process successfully completes, you’ll be redirected back to Stitch.
- Click All Done.
Step 8: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Salesforce integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
-
Optional: To define a table’s Replication Method, click Table Settings on the right side of the page.
Whenever possible, Stitch will default to using Key-based Incremental Replication. In these cases, the table’s Replication Key will be automatically selected and cannot be changed.
To change the table’s Replication Method:
-
Select the Replication Method you want the table to use. Note: Some tables can only be replicated using Full Table Replication. Key-based Incremental Replication will be greyed out when this is applicable.
-
Click Update Settings.
-
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
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.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
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 reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 2 of this integration.
This is the latest version of the Salesforce integration.
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 documentation, 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
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
account
Replication Method : |
Key-based Incremental |
Replication Key |
systemModStamp |
Primary Key |
id |
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
The account ID. Reference: |
systemModStamp
The time when a user or automated process (ex: a trigger) last modified the account. |
accountNumber
The account number assigned to this account. |
accountSource
The source of the account record. For example: |
annualRevenue
The estimated annual revenue of the account. |
billingAddress
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:
|
billingCity
The account’s billing city. |
billingCountry
The account’s billing country. |
billingCountryCode
The ISO country code for the account’s billing address. |
billingGeocodeAccuracy
The compound form of the accuracy level of the geocode for the account’s billing address. |
billingLatitude
Used with |
billingLongitude
Used with |
billingPostalCode
The postal code for the account’s billing address. |
billingState
The state for the account’s billing address. |
billingStateCode
The ISO state code for the account’s billing address. |
billingStreet
The street address for the account’s billing address. |
cleanStatus
The account’s clean status as compared with Data.com. Possible values are:
|
connectionReceivedId
The ID of the |
description
The description of the account. |
dunsNumber
The Data Universal Numbering System (DUNS) number associated with the account. Only available if using Data.com Prospector or Data.com Clean. |
fax
The fax number associated with the account. |
industry
The industry associated with the account. |
isCustomerPortal
Indicates whether the account has at least one contact enabled to use the organization’s Customer Portal. This field will be |
isDeleted
Indicates if the account has been moved to the Recycle Bin ( |
isPartner
Indicates whether the account has at least one contact enabled to use the organization’s partner portal ( |
isPersonAccount
Indicates if the account has a record type of Person Account ( |
jigsaw
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
The due date of the most recently logged event OR the most recently closed task associated with the account, whichever is more recent. |
lastReferenceDate
The date a record associated with the account was last viewed. |
lastViewedDate
The date the account was last viewed. |
masterRecordId
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 |
naicsCode
The North American Industry Classification System (NAICS) code associated with the account. Only available if using Data.com Prospector or Data.com Clean. |
naicsDescription
The description associated with the account’s NAICS code. Only available if using Data.com Prospector or Data.com Clean. |
name
The name of the account. If the account’s record type is |
numberOfEmployees
The number of employees working at the company represented by the account. |
operatingHoursId
The operating hours associated with the account. Only available if Field Service Lightning is enabled. |
ownerId
The ID of the user who currently owns the account. Reference: |
ownership
The ownership type for the account. For example: |
parentId
The ID of the account’s parent object, if applicable. |
phone
The phone number associated with the account. |
photoUrl
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
The account’s prospect rating. For example: |
recordTypeId
The ID of the record type assigned to the account. |
salutation
The honorific added to the name for use in letters, etc. |
shippingAddress
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:
|
shippingCity
The account’s shipping city. |
shippingCountry
The account’s shipping country. |
shippingCountryCode
The ISO country code for the account’s shipping address. |
shippingGeocodeAccuracy
The compound form of the accuracy level of the geocode for the account’s shipping address. |
shippingLatitude
Used with |
shippingLongitude
Used with |
shippingPostalCode
The postal code for the account’s shipping address. |
shippingState
The state for the account’s shipping address. |
shippingStateCode
The ISO state code for the account’s shipping address. |
shippingStreet
The street address for the account’s shipping address. |
sic
The Standard Industrial Classification code of the company’s main business organization. |
sicDesc
The description associated with the account’s SIC code. |
site
The name of the account’s location. For example: |
tickerSymbol
The stock market symbol associated with the account. |
tradeStyle
Similar to |
type
The type of the account. For example: |
website
The website associated with the account. |
yearStarted
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 |
Official docs : |
The contact
table contains info about your contacts, who are individuals associated with accounts in your Salesforce instance.
id
The contact ID. Reference: |
systemModStamp
The time when a user or automated process (ex: a trigger) last modified the contact. |
accountId
The ID of the account that is the parent of the contact. Reference: |
assistantName
The name of the assistant. |
assistantPhone
The phone number associated with the contact. |
birthdate
The birthdate of the contact. |
canAllowPortalSelfReg
Indicates if the contact can self-register for your organization’s Customer Portal ( |
cleanStatus
The contact’s clean status as compared with Data.com. Possible values are:
|
connectionReceivedId
The ID of the |
connectionSentId
The ID of the |
department
The department of the contact. |
description
The description of the contact. |
doNotCall
Indicates if the contact does not want to be called ( |
email
The email address associated with the contact. |
emailBouncedDate
If bounce management is activated and an email sent to the contact bounces, the date and time the bounce occurred. |
emailBouncedReason
If bounce management is activated and an email sent to the contact bounces, the reason the bounce occurred. |
fax
The fax number associated with the contact. |
firstName
The first name of the contact. |
hasOptedOutOfEmail
Indicates if the contact would prefer not to receive email from Salesforce ( |
hasOptedOutOfFax
Indicates if the contact would prefer not to receive faxes ( |
homePhone
The home phone number associated with the contact. |
isDeleted
Indicates if the contact has been moved to the Recycle Bin ( |
isEmailBounced
If bounce management is activated and an email is sent to a contact, indicates if the email bounced ( |
isPersonAccount
Indicates if the contact has a record type of Person Account ( |
jigsaw
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
The due date of the most recently logged event OR the most recently closed task associated with the contact, whichever is more recent. |
lastName
The last name of the contact. |
lastReferenceDate
The date a record associated with the contact was last viewed. |
lastViewedDate
The date the contact was last viewed. |
leadSource
The source of the lead. |
mailingAddress
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:
|
mailingCity
The contact’s mailing city. |
mailingCountry
The contact’s mailing country. |
mailingCountryCode
The ISO country code for the contact’s mailing address. |
mailingGeocodeAccuracy
The compound form of the accuracy level of the geocode for the contact’s mailing address. |
mailingLatitude
Used with |
mailingLongitude
Used with |
mailingPostalCode
The postal code for the contact’s mailing address. |
mailingState
The state for the contact’s mailing address. |
mailingStateCode
The ISO state code for the contact’s mailing address. |
mailingStreet
The street address for the contact’s mailing address. |
masterRecordId
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 |
middleName
The middle name of the contact. |
mobilePhone
The mobile phone number associated with the contact. |
name
The concatenation of If using the Bulk API, track the following fields to replicate the same data:
|
otherAddress
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:
|
otherCity
The contact’s alternate city. |
otherCountry
The contact’s alternate country. |
otherCountryCode
The ISO country code for the contact’s alternate address. |
otherGeocodeAccuracy
The compound form of the accuracy level of the geocode for the contact’s alternate address. |
otherLatitude
Used with |
otherLongitude
Used with |
otherPostalCode
The postal code for the contact’s alternate address. |
otherState
The state for the contact’s alternate address. |
otherStateCode
The ISO state code for the contact’s alternate address. |
otherStreet
The street address for the contact’s alternate address. |
otherPhone
The phone number associated with the contact’s alternate address. |
ownerId
The ID of the owner of the account associated with the contact. Reference: |
phone
The phone number associated with the contact. |
photoUrl
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
The ID of the record type assigned to the contact. |
reportsToId
If |
salutation
The honorific added to the contact’s name for use in letters, etc. |
suffix
The name suffix of the contact. |
title
The title of the contact. For example: |
lead
Replication Method : |
Key-based Incremental |
Replication Key |
systemModStamp |
Primary Key |
id |
Official docs : |
The lead
table contains info about your leads, who are prospects or potential Opportunities.
id
The lead ID. |
systemModStamp
The time when a user or automated process (ex: a trigger) last modified the lead. |
address
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:
|
annualRevenue
The estimated annual revenue for the lead’s company. |
city
The city for the address of the lead. |
cleanStatus
The lead’s clean status as compared with Data.com. Possible values are:
|
company
The company associated with the lead. |
companyDunsNumber
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
The ID of the |
convertedAccountId
The reference ID that points to the Account into which the lead has been converted. Reference: |
convertedContactId
The reference ID that points to the Contact into which the lead has been converted. Reference: |
convertedDate
The date on which the lead was converted. |
convertedOpportunityId
The reference ID that points to the Opportunity into which the lead has been converted. Reference: |
country
The country for the address of the lead. |
countryCode
The ISO country code for the lead’s address. |
currencyIsoCode
The ISO code for any currency allowed by the organization. Only available for organizations with the multicurrency feature enabled. |
description
The description of the lead. |
division
The logical segment of your organization’s data. For example: |
email
The email address associated with the lead. |
emailBouncedDate
If bounce management is activated and an email sent to the lead bounces, the date and time the bounce occurred. |
emailBouncedReason
If bounce management is activated and an email sent to the lead bounces, the reason the bounce occurred. |
fax
The fax number associated with the lead. |
firstName
The first name of the lead. |
hasOptedOutOfEmail
Indicates if the lead would prefer not to receive email from Salesforce ( |
geocodeAccuracy
The compound form of the accuracy level of the geocode for the lead’s address. |
industry
The industry the lead works in. |
isConverted
Indicates if the lead has been converted ( |
isDeleted
Indicates if the lead has been moved to the Recycle Bin ( |
isUnreadByOwner
If |
jigsaw
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
The due date of the most recently logged event OR the most recently closed task associated with the lead, whichever is more recent. |
lastName
The last name of the lead. |
lastReferenceDate
The date a record associated with the lead was last viewed. |
lastViewedDate
The date the lead was last viewed. |
latitude
Used with |
longitude
Used with |
leadSource
The source from which the lead was obtained. |
masterRecordId
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 |
middleName
The middle name of the lead. |
mobilePhone
The mobile phone number associated with the lead. |
name
The concatenation of If using the Bulk API, track the following fields to replicate the same data:
|
numberOfEmployees
The number of employees at the lead’s company. |
ownerId
The ID of the owner of the lead. Reference: |
partnerAccountId
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
The phone number associated with the lead. |
photoUrl
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
The postal code for the lead’s address. |
rating
The rating of the lead. |
recordTypeId
The ID of the record type assigned to the lead. |
salutation
The salutation of the lead. |
scoreIntelligenceId
The ID of the intelligent field record that contains the lead score. |
state
The state for the lead’s address. |
stateCode
The ISO state code for the lead’s address. |
status
The status code of the converted lead. |
street
The street address for the lead’s address. |
suffix
The name suffix of the lead. |
title
The title of the lead. For example: |
website
The website for the lead. |
opportunity
Replication Method : |
Key-based Incremental |
Replication Key |
systemModStamp |
Primary Key |
id |
Official docs : |
The opportunity
table contains info about your opportunities, which are sales or pending deals.
id
The opportunity ID. Reference: |
systemModStamp
The time when a user or automated process (ex: a trigger) last modified the opportunity. |
accountId
The ID of the account associated with the opportunity. Reference: |
amount
The estimated total sale amount. For opportunities with products, the amount will be the total sum of the related products. |
campaignId
The ID of a related campaign. Only defined for organizations where the campaign feature is enabled. |
closeDate
The date the opportunity is expected to close. |
connectionReceivedId
The ID of the |
connectionSentId
The ID of the |
currencyIsoCode
The ISO code for any currency allowed by the organization. Only available for organizations with the multicurrency feature enabled. |
description
The description of the opportunity. |
expectedRevenue
Amount equal to the product of the opportunity |
fiscal
The name of the fiscal quarter or period in which the opportunity |
fiscalQuarter
The numerical representation of the fiscal quarter. Possible values are |
fiscalYear
The fiscal year. |
forecastCategory
The forecast category for the opportunity. |
forecastCategoryName
The name of the forecast category for the opportunity. |
hasOpenActivity
Indicates if the opportunity has associated line items ( |
hasOpportunityLineItem
Indicates if the opportunity has an open event ( |
hasOverdueTask
Indicates if an opportunity has an overdue task ( |
isClosed
Indicates if the opportunity is closed ( |
isDeleted
Indicates if the opportunity has been moved to the Recycle Bin ( |
isExcludedFromTerritory2Filter
Indicates if the opportunity is exclued ( |
isSplit
Indicates whether credit for the opportunity is split between team members ( |
isWon
Indicates if the opportunity is won ( |
lastActivityDate
The due date of the most recently logged event OR the most recently closed task associated with the opportunity, whichever is more recent. |
lastReferenceDate
The date a record associated with the opportunity was last viewed. |
lastViewedDate
The date the opportunity was last viewed. |
leadSource
The source from which the opportunity was obtained. For example: |
name
The name of the opportunity. |
nextStep
The description of the next task in closing the opportunity. |
ownerId
The ID of the user who has been assigned to work the opportunity. Reference: |
pricebook2Id
The ID of the related Pricebook2 object. Only available if the products feature is enabled for an organization. |
pricebookId
The ID of the related Pricebook object. Deprecated by Salesforce. |
probability
The percentage of estimated confidence in closing the opportunity. |
recordTypeId
The ID of the record type assigned to the opportunity. |
stageName
The current stage of the opportunity. |
syncedQuoteId
The ID of the quote that syncs with the opportunity. |
territory2Id
The ID of the territory assigned to the opportunity. Only available if Enterprise Territory Management is enabled. |
totalOpportunityQuantity
The number of items included in the opportunity. |
type
The type of opportunity. For example: |
user
Replication Method : |
Key-based Incremental |
Replication Key |
systemModStamp |
Primary Key |
id |
Official docs : |
The user
table contains info about the users in your organization.
id
The user ID. Reference: |
systemModStamp
The time when a user or automated process (ex: a trigger) last modified the user. |
aboutMe
Information about the user, such as areas of interest or skills. |
accountId
The ID of the account associated with a Customer Portal user. This field will be Reference: |
address
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:
|
alias
The user’s alias. |
badgeText
The text description of a user badge that appears over the user’s photo. |
bannerPhotoUrl
The URL for the user’s banner photo. |
callCenterId
The call center to which the user is assigned. Only available if Salesforce CRM Call Center is enabled. |
city
The city associated with the user. |
communityNickname
The name used to identify this user in the Community application, which includes the ideas and answers features. |
companyName
The name of the user’s company. |
contactId
The ID of the contact associated with the account. Reference: |
country
The country associated with the user. |
countryCode
The ISO country code associated with the user. |
defaultCurrencyIsoCode
The user’s default currency setting for new records. |
defaultDivision
The user’s default division. Only applicable if divisions are enabled. |
defaultGroupNotificationFrequency
The default frequency for sending the user’s Chatter group email notifications when the user joins groups. Possible values are:
|
delegatedApproverId
The ID of the user who is a delegated approver for the user. Reference: |
department
The company department associated with the user. |
digestFrequency
The frequency at which the system sends the user’s Chatter personal digest. Possible values are:
|
division
The division associated with the user. This is similar to |
email
The email address associated with the user. |
emailEncodingKey
The email encoding for the user, such as |
emailPreferencesAutoBcc
Indicates if the user receives copies of sent emails ( |
employeeNumber
The user’s employee number. |
extension
The user’s phone extension number. |
fax
The fax number associated with the user. |
federationIdentifier
The value that must be listed in the |
firstName
The user’s first name. |
forecastEnabled
Indicates if the user is enabled as a Forecast Manager ( |
fullPhotoUrl
The URL for the user’s current profile photo. |
isActive
Indicates if the user has access to log in ( |
isPortalEnabled
Indicates if the user has access to Communities or portals ( |
isPortalSelfRegistered
Indicates if the user is a Customer Portal user who self-registered for your organization’s Customer Portal ( |
isPrmSuperUser
Indicates if the user has super user access in the partner portal ( |
isProfilePhotoActive
Indicates if the user has a profile photo ( |
jigsawImportLimitOverride
The Data.com user’s monthly addition limit. |
languageLocaleKey
The user’s language. For example: |
lastLoginDate
The date and time when the user last successfully logged in. |
lastName
The user’s last name. |
lastReferenceDate
The date a record associated with the lead was last viewed. |
lastViewedDate
The date the lead was last viewed. |
latitude
Used with |
localeSidKey
|
longitude
Used with |
manager
The user’s manager. |
managerId
The ID of the user who manages the user. Reference: |
mediumBannerPhotoUrl
The URL for the user’s medium-sized user profile banner photo. |
middleName
The user’s middle name. This field must be enabled by Salesforce. |
mobilePhone
The mobile phone number associated with the user. |
name
The concatenation of If using the Bulk API, track the |
offlineTrialExpirationDate
The date and time when the user’s Connect Offline trial expires. |
phone
The phone number associated with the user. |
portalRole
The role of the user in the Customer Portal. Possible values are:
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
The user’s postal or ZIP code. |
profileId
The ID of the user’s profile. |
receivesAdminInfoEmails
Indicates if the user receives email for administrators from Salesforce ( |
receivesInfoEmails
Indicates if the user receives informational email from Salesforce ( |
senderEmail
The |
senderName
The name used as the email sender when the user sends emails. |
signature
The signature text added to emails. |
smallBannerPhotoUrl
The URL for the user’s small user profile banner photo. |
smallPhotoUrl
The URL for the thumbnail of the user’s current profile photo. |
state
The state associated with the user. |
stateCode
The ISO state code of the state associated with the user. |
street
The street address for the lead’s address. |
suffix
The name suffix of the lead. |
timeZoneSidKey
|
title
The business title of the user. For example: |
username
The name the user enters to log into the API or user interface. |
userPermissionsCallCenterAutoLogin
Indicates if the user is enabled to use the auto login feature of the call center ( |
userPermissionsChatterAnswersUser
Indicates if the portal user is enabled to use the Chatter Answers feature ( |
userPermissionsInteractionUser
Indicates if the user can run flows ( |
userPermissionsJigsawProspectingUser
Indicates if the user is allocated one Data.com user license ( |
userPermissionsKnowledgeUser
Indicates if the user is enabled to use Salesforce Knowledge ( |
userPermissionsLiveAgentUser
Indicates if the user is enabled to use Live Agent ( |
userPermissionsMarketingUser
Indicates if the user is enabled to manage campaigns in the user interface ( |
userPermissionsMobileUser
Indicates if the user is allocated one Salesforce Mobile Classic license ( |
userPermissionsOfflineUser
Indicates if the user is enabled to use Offline Edition ( |
userPermissionsSFContentUser
Indicates if the user is allocated one Salesforce CRM Content User license ( |
userPermissionsSiteforceContributorUser
Indicates if the user is allocated one Site.com Contributor feature license ( |
userPermissionsSiteforcePublisherUser
Indicates if the user is allocated one Site.com Publisher feature license ( |
userPermissionsSupportUser
Indicates if the user is enabled to use the Salesforce console ( |
userPermissionsWorkDotComeUserFeature
Indicates if the Work.com feature is enabled for the user ( |
userPreferencesAcitivityRemindersPopup
When |
userPreferencesApexPagesDeveloperMode
When |
userPreferencesContentEmailAsAndWhen
When |
userPreferencesContentNoEmail
When |
userPreferencesEnableAutoSubForFeeds
When |
userPreferencesDisableAllFeedsEmail
When |
userPreferencesDisableBookmarkEmail
When |
userPreferencesDisableChangeCommentEmail
When |
userPreferencesDisableEndorsementEmail
When |
userPreferencesDisableFileShareNotificationsForApi
When |
userPreferencesDisableFollowersEmail
When |
userPreferencesDisableLaterCommentEmail
When |
userPreferencesDisableLikeEmail
When |
userPreferencesDisableMentionsPostEmail
When |
userPreferencesDisableMentionsPostEmail
When |
userPreferencesDisableProfilePostEmail
When |
userPreferencesDisableSharePostEmail
When |
userPreferencesDisableFeedbackEmail
When |
userPreferencesDisCommentAfterLikeEmail
When |
userPreferencesDisMentionsCommentEmail
When |
userPreferencesDisableMessageEmail
When |
userPreferencesDisableRewardEmail
When |
userPreferencesDisableWorkEmail
When |
userPreferencesDisProfPostCommentEmail
When |
userPreferencesEventRemindersCheckboxDefault
When |
userPreferencesHideBiggerPhotoCallout
When |
userPreferencesHideChatterOnboardingSplash
When |
userPreferencesHideCSNDesktopTask
When |
userPreferencesHideCSNGetChatterMobileTask
When |
userPreferencesHideHideSecondChatterOnboardingSplash
When |
userPreferencesHideS1BrowserUI
When |
userPreferencesHideSfxWelcomeMat
Indicates if the user sees the Lightning Experience new user message ( |
userPreferencesJigsawListUser
When |
userPreferencesLightningExperiencePreferred
When |
userPreferencesPathAssistantCollapsed
When |
userPreferencesReminderSoundOff
When |
userPreferencesShowCityToExternalUsers
When |
userPreferencesShowCityToGuestUsers
When |
userPreferencesShowCountryToExternalUsers
When |
userPreferencesShowCountryToGuestUsers
When |
userPreferencesShowEmailToExternalUsers
When |
userPreferencesShowEmailToGuestUsers
When |
userPreferencesShowFaxToExternalUsers
When |
userPreferencesShowFaxToGuestUsers
When |
userPreferencesShowManagerToExternalUsers
When |
userPreferencesShowManagerToGuestUsers
When |
userPreferencesShowMobilePhoneToExternalUsers
When |
userPreferencesShowMobilePhoneToGuestUsers
When |
userPreferencesShowPostalCodeToExternalUsers
When |
userPreferencesShowPostalCodeToGuestUsers
When |
userPreferencesShowProfilePicToExternalUsers
When |
userPreferencesShowProfilePicToGuestUsers
When |
userPreferencesShowStateToExternalUsers
When |
userPreferencesShowStateToGuestUsers
When |
userPreferencesShowStreetAddressToExternalUsers
When |
userPreferencesShowStreetAddressToGuestUsers
When |
userPreferencesShowTitleToExternalUsers
When |
userPreferencesShowTitleToGuestUsers
When |
userPreferencesShowWorkPhoneToExternalUsers
When |
userPreferencesShowWorkPhoneToGuestUsers
When |
userPreferencesSortFeedByComment
When |
userPreferencesTaskRemindersCheckboxDefault
When |
userRoleId
The ID of the user role assigned to the user. |
userType
The category of the user license allocated to the user. Possible values include:
|
Related | Troubleshooting |
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.