Establishing a Connection

Create a connection to Salesloft by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Salesloft icon is not available, click the Add More icon to download and install the Salesloft connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Connecting to Salesloft

Salesloft uses the OAuth and APIKey authentication standard. OAuth requires the authenticating user to interact with Salesloft using the browser. The provider facilitates this in various ways as described below.

Authenticate a Salesloft Account

OAuth

For OAuth authentication, it's necessary to create an OAuth app. See Creating a Custom OAuth App for a process.

API Key

Alternatively, authenticate with an APIKey. Provision an API key from the Salesloft user interface: https://accounts.salesloft.com/oauth/applications/.

You will receive a Key which will be used when issuing requests.

Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to Salesloft APIs.

Key Features

The Sync App models Salesloft entities like accounts, people, and tasks as relational views, allowing you to write SQL to query Salesloft data.
Stored procedures allow you to execute operations to Salesloft
Live connectivity to these objects means any changes to your Salesloft account are immediately reflected when using the Sync App.

Views

Views describes the available views. Views are statically defined to model AccountStages, AccountTiers,Actions, etc.

Tables

Tables describes the available tables. Tables are statically defined to model Accounts, People, Imports, Tasks, etc.

Stored Procedures

Stored Procedures are function-like interfaces to Salesloft. Stored procedures allow you to execute operations to Salesloft, including downloading documents and moving envelopes.

Tables

The Sync App models the data in Salesloft into a list of tables that can be queried using standard SQL statements.

Generally, querying Salesloft tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Salesloft Connector for CData Sync Tables


Name	Description
Accounts	Create, update, and query the available accounts in SalesLoft.
Imports	Create, update, and query the available Imports in SalesLoft.
People	Create, update, and query the available people in SalesLoft.
SavedListViews	Create, update, and query the available saved list views in SalesLoft.
Tasks	Create, update, and query the available task records in SalesLoft.

Accounts

Create, update, and query the available accounts in SalesLoft.

Select

The Sync App will use the Salesloft API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

ID supports the following operators: =,IN
AccountTierId supports the following operators: =,IN,IS NULL
CreatedAt supports the following operators: >, >=, <, <=
CrmId supports the following operators: =,IN
Domain supports the following operators: =,IN
LastContactedAt supports the following operators: >, >=, <, <=
OwnerId supports the following operators: =,IN,IS NULL
Tags supports the following operators: =,IN
UpdatedAt supports the following operators: >, >=, <, <=
Website supports the following operators: =,IN,IS NULL
Archived supports the following operator: =
TagId supports the following operators: =,IN
AccountStageId supports the following operators: =,IN,IS NULL
OwnerIsActive supports the following operator: =
CustomFields* supports the following operator: =. The customFields that are created by the Salesloft Admin can be filtered by specifying the name as it is visible in the UI.

The following queries are processed server side:

    SELECT * FROM Accounts WHERE ID = 123
    SELECT * FROM Accounts WHERE AccountTierId IN ('123', '1234')
    SELECT * FROM Accounts WHERE CreatedAt >= '2022-12-01'
    SELECT * FROM Accounts WHERE CrmId IN ('123', '1234')
    SELECT * FROM Accounts WHERE Domain IN ('domainA', 'domainB')
	SELECT * FROM Accounts WHERE MyCustomFiled = 'customValue'
	,etc.

Insert

To add an Account, at least the Domain and Name need to be specified. The Sync App is able to execute an insert in two ways.

  INSERT INTO Accounts (Domain, Name, Description)
    VALUES ('DomainTest.com', 'TestAccount', 'Description of test account' )

Or using Bulk Insert:

INSERT INTO Accounts#TEMP (Domain, Name, Description) VALUES ('DomainTest.com', 'TestAccount', 'Description of test account' )
INSERT INTO Accounts#TEMP (Domain, Name, Description) VALUES ('DomainTest1.com', 'TestAccount1', 'Description of test account1' )

INSERT INTO Accounts (Domain, Name, Description)
SELECT Domain, Name, Description FROM Accounts#TEMP

Update

Similarly, to the Insert operation we can update an item by specifying the field and the new value.

UPDATE Accounts SET Description = 'Updated Description', Phone = '123', Country = 'US', State = 'CA'
       WHERE ID = 13391259

Upsert

To perform an upsert operation, the upsert Key must be provided. Valid options are: ID, CrmId, Domain. Additionally, the Salesloft can perform a batch Upsert for more than 1 record.

UPSERT INTO Accounts (name, id, domain, description, Tags, OwnerId)
		VALUES ('AccountN' ,10917448, 'AccountDom.com', 'This is an upsert', 'tag1Upsert,tag2Upsert', 16081 )

Delete

In order to delete an Account the ID needs to be specified, for ex.:

DELETE FROM Accounts WHERE ID = 100

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	The Id property of the Account table.
AccountTierId	Integer	False	The AccountTierId property of the Account table.
ArchivedAt	Datetime	True	The ArchivedAt property of the Account table.
City	String	False	The City property of the Account table.
CompanyStageId	Integer	False	The CompanyStageId property of the Account table.
CompanyType	String	False	The CompanyType property of the Account table.
ConversationalName	String	True	The ConversationalName property of the Account table.
Country	String	False	The Country property of the Account table.
CountsPeople	Integer	False	The CountsPeople property of the Account table.
CreatedAt	Datetime	True	The CreatedAt property of the Account table.
CreatorId	Integer	False	The CreatorId property of the Account table.
CrmId	String	False	The CrmId property of the Account table.
CrmObjectType	String	False	The CrmObjectType property of the Account table.
CrmUrl	String	False	The CrmUrl property of the Account table.
Description	String	False	The Description property of the Account table.
DoNotContact	Boolean	False	The DoNotContact property of the Account table.
Domain	String	False	The Domain property of the Account table.
Founded	String	False	The Founded property of the Account table.
Industry	String	False	The Industry property of the Account table.
LastContactedAt	Datetime	True	The LastContactedAt property of the Account table.
LastContactedById	Integer	False	The LastContactedById property of the Account table.
LastContactedPersonId	Integer	False	The LastContactedPersonId property of the Account table.
LastContactedType	String	False	The LastContactedType property of the Account table.
LinkedinUrl	String	False	The LinkedinUrl property of the Account table.
Locale	String	False	The Locale property of the Account table.
Name	String	False	The Name property of the Account table.
OwnerId	Integer	False	The OwnerId property of the Account table.
OwnerCrmId	String	False	The OwnerCrmId property of the Account table.
Phone	String	False	The Phone property of the Account table.
PostalCode	String	False	The PostalCode property of the Account table.
RevenueRange	String	False	The RevenueRange property of the Account table.
Size	String	False	The Size property of the Account table.
State	String	False	The State property of the Account table.
Street	String	False	The Street property of the Account table.
Tags	String	False	The Tags property of the Account table.
TwitterHandle	String	False	The TwitterHandle property of the Account table.
UpdatedAt	Datetime	True	The UpdatedAt property of the Account table.
Website	String	False	The Website property of the Account table.
Archived	Boolean	False	The Archived property of the Account table.
TagId	Integer	False	The TagId property of the Account table.
AccountStageId	Integer	False	The AccountStageId property of the Account table.
OwnerIsActive	Boolean	False	The OwnerIsActive property of the Account table.

Imports

Create, update, and query the available Imports in SalesLoft.

Select

The Sync App will use the Salesloft API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

Id supports the following operators: =,IN
UserIDs supports the following operators: =,IN

The following queries are processed server side:

    SELECT * FROM Imports WHERE Id IN (1234, 4321)
    SELECT * FROM Imports WHERE UserIDs IN (123, 321)

Insert

To add an Import UserId and Name need to be specified.

  INSERT INTO Imports (UserId, Name)
    VALUES (123, 'ImportTest')

Update

Similarly to the Insert operation, update an Import by specifying the field and the new value.

UPDATE Imports SET Name = 'new test'
        WHERE Id = 123

Delete

In order to delete an Import the Id needs to be specified, for ex.

DELETE FROM Imports WHERE Id = 100

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	False	The Id of the Import.
CreatedAt	Datetime	True	The CreatedAt of the Import.
UpdatedAt	Datetime	True	The UpdatedAt of the Import.
Name	String	False	The Name of the Import.
CurrentPeopleCount	Integer	False	The CurrentPeopleCount of the Import.
ImportedPeopleCount	Integer	False	The ImportedPeopleCount of the Import.
UserIDs	String	False	The OwnedByGuid property of the Import table.

People

Create, update, and query the available people in SalesLoft.

Select

The Sync App will use the Salesloft API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

Id supports the following operators: =,IN
AccountId supports the following operators: =,IN
CreatedAt supports the following operators: >, >=, <, <=
CrmId supports the following operators: =,IN
DoNotContact supports the following operator: =
EmailAddress supports the following operators: =,IN,IS NULL
ImportId supports the following operators: =, IN,IS NULL
JobSeniority supports the following operators: =,IN,IS NULL
LastContactedAt supports the following operators: >, >=, <, <=
PersonStageId supports the following operators: =,IN,IS NULL
Tags supports the following operator: =,IN
Title supports the following operator: =
UpdatedAt supports the following operators: >, >=, <, <=
OwnedByGuid supports the following operators: =,IN
CanEmail supports the following operator: =
CanCall supports the following operator: =
TagId supports the following operators: =,IN
OwnerIsActive supports the following operator: =
CadenceId supports the following operators: =,IN,IS NULL
CustomFields* supports the following operator: =. The customFields that are created by Salesloft Admin can be filtered by specifying the name as it is on the UI.

The following queries are processed server side:

    SELECT * FROM People WHERE Id = 123
    SELECT * FROM People WHERE AccountId IN (123,1234)
    SELECT * FROM People WHERE EmailAddress IS NULL
    SELECT * FROM People WHERE MyCustomFiled = 'customValue'
	,etc.

Insert

To add a Person, at least the EmailAddress, FirstName and LastName need to be specified. Execute an insert in one of 2 ways.

  INSERT INTO People (EmailAddress, Phone, FirstName, LastName) VALUES ('[email protected]', '123456', 'FirstNameTest', 'LastNameTest')

Or using Bulk Insert:

INSERT INTO People#TEMP (EmailAddress, Phone, FirstName, LastName) VALUES ('[email protected]', '123456', 'FirstNameTest', 'LastNameTest')
INSERT INTO People#TEMP (EmailAddress, Phone, FirstName, LastName) VALUES ('[email protected]', '1234567', 'FirstNameTest1', 'LastNameTest1')

INSERT INTO People (EmailAddress, Phone, FirstName, LastName)
SELECT EmailAddress, Phone, FirstName, LastName FROM People#TEMP

Update

Similarly, to the Insert operation we can update a Person by specifying the field and the new value.

UPDATE People SET Phone = '123456', Tags = 'tag1,tag2', WorkCity = 'NewCity'
	WHERE Id = 123

Upsert

To perform an upsert operation, the upsert Key must be provided. Valid options are: ID, CrmId, EmailAddress. Additionally, the Sync App can perform a batch Upsert for more than 1 record.

UPSERT INTO People (FirstName, Id, Phone)
		VALUES ('AccountN' ,10917448, '123')

Delete

In order to delete a Person, the Id needs to be specified.

DELETE FROM People WHERE Id = 100

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	The Id property of the People table.
AccountId	Integer	False	The AccountId property of the People table.
Bouncing	Boolean	False	The Bouncing property of the People table.
City	String	False	The City property of the People table.
ContactRestrictions	String	False	The ContactRestrictions property of the People table.
Country	String	False	The Country property of the People table.
CountsCalls	Integer	False	The CountsCalls property of the People table.
CountsEmailsBounced	Integer	True	The CountsEmailsBounced property of the People table.
CountsEmailsClicked	Integer	False	The CountsEmailsClicked property of the People table.
CountsEmailsRepliedTo	Integer	False	The CountsEmailsRepliedTo property of the People table.
CountsEmailsSent	Integer	False	The CountsEmailsSent property of the People table.
CountsEmailsViewed	Integer	False	The CountsEmailsViewed property of the People table.
CreatedAt	Datetime	True	The CreatedAt property of the People table.
CrmId	String	False	The CrmId property of the People table.
CrmObjectType	String	False	The CrmObjectType property of the People table.
CrmUrl	String	False	The CrmUrl property of the People table.
DisplayName	String	False	The DisplayName property of the People table.
DoNotContact	Boolean	False	The DoNotContact property of the People table.
EmailAddress	String	False	The EmailAddress property of the People table.
FirstName	String	False	The FirstName property of the People table.
FullEmailAddress	String	False	The FullEmailAddress property of the People table.
HomePhone	String	False	The HomePhone property of the People table.
ImportId	Integer	False	The ImportId property of the People table.
JobSeniority	String	False	The JobSeniority property of the People table.
LastCompletedStepId	Integer	False	The LastCompletedStepId property of the People table.
LastCompletedStepCadenceId	Integer	False	The LastCompletedStepCadenceId property of the People table.
LastContactedAt	Datetime	True	The LastContactedAt property of the People table.
LastContactedById	Integer	False	The LastContactedById property of the People table.
LastContactedType	String	False	The LastContactedType property of the People table.
LastName	String	False	The LastName property of the People table.
LastRepliedAt	Datetime	True	The LastRepliedAt property of the People table.
LinkedinUrl	String	False	The LinkedinUrl property of the People table.
Locale	String	False	The Locale property of the People table.
MobilePhone	String	False	The MobilePhone property of the People table.
MostRecentCadenceId	Integer	False	The MostRecentCadenceId property of the People table.
OwnerId	Integer	False	The OwnerId property of the People table.
OwnerCrmId	String	False	The OwnerCrmId property of the People table.
PersonCompanyIndustry	String	False	The PersonCompanyIndustry property of the People table.
PersonCompanyName	String	False	The PersonCompanyName property of the People table.
PersonCompanyWebsite	String	False	The PersonCompanyWebsite property of the People table.
PersonStageId	Integer	False	The PersonStageId property of the People table.
PersonalEmailAddress	String	False	The PersonalEmailAddress property of the People table.
PersonalWebsite	String	False	The PersonalWebsite property of the People table.
Phone	String	False	The Phone property of the People table.
PhoneExtension	String	False	The PhoneExtension property of the People table.
SecondaryEmailAddress	String	False	The SecondaryEmailAddress property of the People table.
State	String	False	The State property of the People table.
Tags	String	False	The Tags property of the People table.
Title	String	False	The Title property of the People table.
TwitterHandle	String	False	The TwitterHandle property of the People table.
UpdatedAt	Datetime	True	The UpdatedAt property of the People table.
WorkCity	String	False	The WorkCity property of the People table.
WorkCountry	String	False	The WorkCountry property of the People table.
WorkState	String	False	The WorkState property of the People table.
OwnedByGuid	String	False	The OwnedByGuid property of the People table.
CanEmail	Boolean	False	The CanEmail property of the People table.
CanCall	Boolean	False	The CanCall property of the People table.
TagId	Integer	False	The TagId property of the People table.
OwnerIsActive	Boolean	False	The OwnerIsActive property of the People table.
CadenceId	Integer	False	The cadenceid property of the People table.

SavedListViews

Create, update, and query the available saved list views in SalesLoft.

Select

The Sync App will use the Salesloft API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

Id supports the following operators: =, IN
View supports the following operator: =. Value must be one of: people, companies, or recordings

The following queries are processed server side:

    SELECT * FROM SavedListViews WHERE Id = 123
    SELECT * FROM SavedListViews WHERE View = 'people'

Insert

To add an entry into SavedListViews, at least the Name and View need to be specified.

  INSERT INTO SavedListViews (Name, View, IsDefault) VALUES ('SampleView', 'people', true)

Update

Similarly to the Insert operation, update a SavedListView by specifying the field and the new value.

UPDATE SavedListViews SET Name = 'NewName', View = 'companies', IsDefault = false WHERE Id = 123

Delete

In order to delete a SavedListViews the Id needs to be specified.

DELETE FROM SavedListViews WHERE Id = 123

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	False	The Id of the Stage.
View	String	False	The View of the Stage.
Name	String	False	The Name of the Stage.
ViewParams	String	False	The ViewParams of the Stage.
IsDefault	Boolean	False	The IsDefault of the Stage.
UpdatedAt	Datetime	True	The UpdatedAt date of the Stage.

Tasks

Create, update, and query the available task records in SalesLoft.

Select

The Sync App will use the Salesloft API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

Id supports the following operators: =,IN
CurrentState supports the following operators: =,IN. Valid CurrentState values are: 'scheduled' and 'completed'
PersonId supports the following operators: =,IN
TaskType supports the following operators: =,IN. Valid TaskType values are: 'call' and 'email'
TimeInterval supports the following operator: =
IdempotencyKey supports the following operator: =

The following queries are processed server side:

    SELECT * FROM Tasks WHERE Id = 123
    SELECT * FROM Tasks WHERE CurrentState IN ('scheduled', 'completed')
    SELECT * FROM Tasks WHERE PersonId IN (123, 321)
    SELECT * FROM Tasks WHERE TaskType IN ('call', 'email')
    SELECT * FROM Tasks WHERE TimeInterval = 'interval'
    SELECT * FROM Tasks WHERE IdempotencyKey = 'key'

Insert

To add a Task, at least the Subject, PersonId, UserId, TaskType, DueDate and CurrentState need to be specified.

  INSERT INTO Tasks (Subject, PersonId, UserId, TaskType, DueDate, CurrentState)
    VALUES ('Subject Task Test', 123, 123, 'email', '2022-12-30', 'scheduled')

Update

Similarly, to the Insert operation we can update a Task by specifying the field and the new value.

UPDATE Tasks SET Subject = 'new Subject', CurrentState = 'completed' WHERE ID = 123

Delete

In order to delete a Task the Id needs to be specified, for ex.

DELETE FROM Tasks WHERE Id = 100

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	False	The Id of the Task.
CompletedAt	Datetime	False	The CompletedAt of the Task.
CompletedById	Integer	False	The CompletedById of the Task.
CreatedAt	Datetime	True	The CreatedAt of the Task.
CreatedByUserId	Integer	False	The CreatedByUserId of the Task.
CurrentState	String	False	The CurrentState of the Task.
DueAt	Datetime	False	The DueAt of the Task.
DueDate	Date	False	The DueDate of the Task.
PersonId	Integer	False	The PersonId of the Task.
RemindAt	Datetime	False	The RemindAt of the Task.
Subject	String	False	The Subject of the Task.
TaskType	String	False	The TaskType of the Task.
UpdatedAt	Datetime	True	The UpdatedAt date of the Task.
UserId	Integer	False	The UserId of the Task.
TimeInterval	String	False	The TimeInterval property of the Task table.
IdempotencyKey	String	False	The IdempotencyKey property of the Task table.

Views

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Salesloft Connector for CData Sync Views


Name	Description
AccountStages	Returns multiple account stage records. The records can be filtered, paged, and sorted according to the respective parameters.
AccountTiers	Returns multiple account tier records. The records can be filtered, paged, and sorted according to the respective parameters.
ActionDetails	Returns multiple call instruction records. The records can be filtered, paged, and sorted according to the respective parameters.
Actions	Returns multiple action records. The records can be filtered, paged, and sorted according to the respective parameters. Only actions that are currently 'in_progess' will be returned by this endpoint. If the requester is not an admin, this endpoint will only return actions belonging to the requester. If the request is an admin, this endpoint will return actions for the entire team. Additionally, an admin may use the user_guid parameter to request actions that belong to specific users on the team.
CadenceMemberships	Returns multiple cadence membership records. The records can be filtered, paged, and sorted according to the respective parameters. A cadence membership is the association between a person and their current and historical time on a cadence. Cadence membership records are mutable and change over time. If a person is added to a cadence and re-added to the same cadence in the future, there is a single membership record.
Cadences	Returns multiple cadence records. The records can be filtered, paged, and sorted according to the respective parameters.
CallDataRecords	Returns multiple call data records. The records can be filtered, paged, and sorted according to the respective parameters. Call data records are records of all inbound and outbound calls through SalesLoft. A call data record may be associated with a call, but does not have to be.
CallDispositions	Returns multiple call disposition records. The records can be sorted according to the respective parameters. Call dispositions must be configured in application. This will change in the future, but please contact us if you have a pressing use case.
CallerIDs	Returns each entry that is a possible caller ID match for the number. Multiple entries may be returned if the phone number is present on more than one person in the system. Phone number should be in E.164 format.
Calls	Returns multiple call records. The records can be filtered, paged, and sorted according to the respective parameters.
CallSentiments	Returns multiple call sentiment records. The records can be sorted according to the respective parameters. Call sentiments must be configured in application. This will change in the future, but please contact us if you have a pressing use case.
CRMActivities	Returns multiple crm activity records. The records can be filtered, paged, and sorted according to the respective parameters.
CRMActivityFields	Returns multiple crm activity field records. The records can be filtered, paged, and sorted according to the respective parameters.
CRMUsers	Returns multiple crm user records.
Emails	Returns multiple email records. The records can be filtered, paged, and sorted according to the respective parameters.
EmailTemplateAttachments	Returns multiple email template attachment records. The records can be filtered and paged according to the respective parameters.
EmailTemplates	Returns multiple email template records. The records can be filtered, paged, and sorted according to the respective parameters.
Groups	Returns multiple group records. The records can be filtered, and sorted according to the respective parameters.
MIMEEmailPayloads	Returns the MIME content for email.
Notes	Returns multiple note records. The records can be filtered, paged, and sorted according to the respective parameters.
PersonStages	Returns multiple person stage records. The records can be filtered, paged, and sorted according to the respective parameters.
Steps	Returns multiple step records. The records can be filtered, paged, and sorted according to the respective parameters.
Successes	Returns multiple success records. The records can be filtered, paged, and sorted according to the respective parameters.
Tags	Fetches a list of the tags used for a team. The records can be filtered, paged, and sorted according to the respective parameters. Tags can be applied to multiple resource types.
Team	Returns the team of the authenticated user.
TeamTemplateAttachments	Returns multiple team template attachment records. The records can be filtered and paged according to the respective parameters.
TeamTemplates	Fetches multiple team template records. The records can be filtered, paged, and sorted according to the respective parameters. Team templates are templates that are available team-wide. Admins may use team templates to create original content for the entire team, monitor version control to ensure templates are always up to date, and track template performance across the entire organization. All metrics on a team template reflect usage across the team; individual metrics can be found with the email_templates API endpoint.
Users	Returns Non Admin: Lists only your user, or all on team depending on group visibility policy Team Admin: Lists users associated with your team.

AccountStages

Returns multiple account stage records. The records can be filtered, paged, and sorted according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the AccountStage.
CreatedAt	Datetime	The CreatedAt date of the AccountStage.
Name	String	The Name of the AccountStage.
Order	Integer	The Order of the AccountStage.
UpdatedAt	Datetime	The UpdatedAt property of the AccountStage table.

AccountTiers

Returns multiple account tier records. The records can be filtered, paged, and sorted according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the AccountTier.
CreatedAt	Datetime	The CreatedAt date of the AccountTier.
Name	String	The Name of the AccountTier.
Order	Integer	The Order of the AccountTier.
UpdatedAt	Datetime	The UpdatedAt property of the AccountTier table.

ActionDetails

Returns multiple call instruction records. The records can be filtered, paged, and sorted according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the ActionDetail.
CreatedAt	Datetime	The CreatedAt date of the ActionDetail.
UpdatedAt	Datetime	The UpdatedAt date of the ActionDetail.
Instructions	String	The Instructions of the ActionDetail.

Actions

Returns multiple action records. The records can be filtered, paged, and sorted according to the respective parameters. Only actions that are currently 'in_progess' will be returned by this endpoint. If the requester is not an admin, this endpoint will only return actions belonging to the requester. If the request is an admin, this endpoint will return actions for the entire team. Additionally, an admin may use the user_guid parameter to request actions that belong to specific users on the team.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the Action.
ActionDetailsId	Integer	The ActionDetailsId of the Action.
CadenceId	Integer	The CadenceId of the Action.
CreatedAt	Datetime	The CreatedAt date of the Action.
Due	Boolean	Returns if the Action is on Due.
DueOn	Datetime	The DueOn date of the Action.
MultitouchGroupId	Integer	The MultitouchGroupId of the Action.
PersonId	Integer	The PersonId of the Action.
Status	String	The Status of the Action.
StepId	Integer	The StepId of the Action.
Type	String	The Type of the Action.
UpdatedAt	Datetime	The UpdatedAt date of the Action.
UserId	Integer	The UserId of the Action.

CadenceMemberships

Returns multiple cadence membership records. The records can be filtered, paged, and sorted according to the respective parameters. A cadence membership is the association between a person and their current and historical time on a cadence. Cadence membership records are mutable and change over time. If a person is added to a cadence and re-added to the same cadence in the future, there is a single membership record.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the CadenceMembership.
AddedAt	Datetime	The AddedAt property of the CadenceMembership table.
CadenceId	Integer	The CadenceId property of the CadenceMembership table.
CountsBounces	Integer	The CountsBounces property of the CadenceMembership table.
CountsCalls	Integer	The CountsCalls property of the CadenceMembership table.
CountsClicks	Integer	The CountsClicks property of the CadenceMembership table.
CountsReplies	Integer	The CountsReplies property of the CadenceMembership table.
CountsSentEmails	Integer	The CountsSentEmails property of the CadenceMembership table.
CountsViews	Integer	The CountsViews property of the CadenceMembership table.
CreatedAt	Datetime	The CreatedAt property of the CadenceMembership table.
CurrentState	String	The CurrentState property of the CadenceMembership table.
CurrentlyOnCadence	Boolean	The CurrentlyOnCadence property of the CadenceMembership table.
LatestActionId	Integer	The LatestActionId property of the CadenceMembership table.
PersonId	Integer	The PersonId property of the CadenceMembership table.
PersonDeleted	Boolean	The PersonDeleted property of the CadenceMembership table.
UpdatedAt	Datetime	The UpdatedAt property of the CadenceMembership table.
UserId	Integer	The UserId property of the CadenceMembership table.

Cadences

Returns multiple cadence records. The records can be filtered, paged, and sorted according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the Cadence.
AddedStageId	Integer	The AddedStageId of the Cadence.
ArchivedAt	Datetime	The ArchivedAt of the Cadence.
BouncedStageId	Integer	The BouncedStageId of the Cadence.
CountsCadencePeople	Integer	The CountsCadencePeople of the Cadence.
CountsTargetDailyPeople	Integer	The CountsTargetDailyPeople of the Cadence.
CreatedAt	Datetime	The CreatedAt of the Cadence.
CreatorId	Integer	The CreatorId of the Cadence.
FinishedStageId	Integer	The FinishedStageId of the Cadence.
Name	String	The Name of the Cadence.
OptOutLinkIncluded	Boolean	The OptOutLinkIncluded of the Cadence.
OwnerId	Integer	The OwnerId of the Cadence.
RemoveBouncesEnabled	Boolean	The RemoveBouncesEnabled of the Cadence.
RemoveRepliesEnabled	Boolean	The RemoveRepliesEnabled of the Cadence.
RepliedStageId	Integer	The RepliedStageId of the Cadence.
Shared	Boolean	The Shared of the Cadence.
Tags	String	The Tags of the Cadence.
TeamCadence	Boolean	The TeamCadence of the Cadence.
UpdatedAt	Datetime	The UpdatedAt of the Cadence.
PeopleAddable	Boolean	The PeopleAddable property of the Cadence table.
OwnedByGuid	String	The OwnedByGuid property of the Cadence table.

CallDataRecords

Returns multiple call data records. The records can be filtered, paged, and sorted according to the respective parameters. Call data records are records of all inbound and outbound calls through SalesLoft. A call data record may be associated with a call, but does not have to be.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the CallDataRecord.
CallId	Integer	The CallId of the CallDataRecord.
CallType	String	The CallType of the CallDataRecord.
CallUuid	String	The CallUuid of the CallDataRecord.
CalledPersonId	Integer	The CalledPersonId of the CallDataRecord.
CreatedAt	Datetime	The CreatedAt of the CallDataRecord.
Direction	String	The Direction of the CallDataRecord.
Duration	Integer	The Duration of the CallDataRecord.
From	String	The From of the CallDataRecord.
RecordingStatus	String	The RecordingStatus of the CallDataRecord.
RecordingUrl	String	The RecordingUrl of the CallDataRecord.
Status	String	The Status of the CallDataRecord.
To	String	The To of the CallDataRecord.
UpdatedAt	Datetime	The UpdatedAt of the CallDataRecord.
UserId	Integer	The UserId of the CallDataRecord.
HasCall	Boolean	The HasCall property of the CallDataRecords table.
UserGuid	String	The UserGuid property of the CallDataRecords table.

CallDispositions

Returns multiple call disposition records. The records can be sorted according to the respective parameters. Call dispositions must be configured in application. This will change in the future, but please contact us if you have a pressing use case.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the CallDisposition.
CreatedAt	Datetime	The CreatedAt of the CallDisposition.
Name	String	The Name of the CallDisposition.
UpdatedAt	Datetime	The UpdatedAt of the CallDisposition.

CallerIDs

Returns each entry that is a possible caller ID match for the number. Multiple entries may be returned if the phone number is present on more than one person in the system. Phone number should be in E.164 format.

Columns


Name	Type	Description
DisplayName	String	The DisplayName of the CallerID.
Title	String	The Title of the CallerID.
AccountName	String	The AccountName of the CallerID.
PersonId	Integer	The PersonId of the CallerID.
PhoneNumber	String	The PhoneNumber property of the CallerIDs table. This property is required in the Select statement.

Calls

Returns multiple call records. The records can be filtered, paged, and sorted according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the Call.
ActionId	Integer	The ActionId of the Call.
CadenceId	Integer	The CadenceId of the Call.
CalledPersonId	Integer	The CalledPersonId of the Call.
CreatedAt	Datetime	The CreatedAt of the Call.
CrmActivityId	Integer	The CrmActivityId of the Call.
Disposition	String	The Disposition of the Call.
Duration	Integer	The Duration of the Call.
NoteId	Integer	The NoteId of the Call.
Recordings	String	The Recordings of the Call.
Sentiment	String	The Sentiment of the Call.
StepId	Integer	The StepId of the Call.
To	String	The To of the Call.
UpdatedAt	Datetime	The UpdatedAt of the Call.
UserId	Integer	The UserId of the Call.
PersonId	String	The PersonId property of the Calls table.

CallSentiments

Returns multiple call sentiment records. The records can be sorted according to the respective parameters. Call sentiments must be configured in application. This will change in the future, but please contact us if you have a pressing use case.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the CallSentiment.
CreatedAt	Datetime	The CreatedAt of the CallSentiment.
Name	String	The Name of the CallSentiment.
UpdatedAt	Datetime	The UpdatedAt of the CallSentiment.

CRMActivities

Returns multiple crm activity records. The records can be filtered, paged, and sorted according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the CRMActivity.
CreatedAt	Datetime	The CreatedAt of the CRMActivity.
UpdatedAt	Datetime	The UpdatedAt of the CRMActivity.
Subject	String	The Subject of the CRMActivity.
Description	String	The Description of the CRMActivity.
CrmId	String	The CrmId of the CRMActivity.
ActivityType	String	The ActivityType of the CRMActivity.
CustomCrmFieldsAggr	String	The CustomCrmFieldsAggr of the CRMActivity.
PersonId	Integer	The PersonId of the CRMActivity.
UserId	Integer	The UserId of the CRMActivity.

CRMActivityFields

Returns multiple crm activity field records. The records can be filtered, paged, and sorted according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the CRMActivityField.
CreatedAt	Datetime	The CreatedAt of the CRMActivityField.
CrmObjectType	String	The CrmObjectType of the CRMActivityField.
Field	String	The Field of the CRMActivityField.
FieldType	String	The FieldType of the CRMActivityField.
PicklistValuesHigh	String	The PicklistValuesHigh of the CRMActivityField.
PicklistValuesLow	String	The PicklistValuesLow of the CRMActivityField.
SalesforceObjectType	String	The SalesforceObjectType of the CRMActivityField.
Source	String	The Source of the CRMActivityField.
Title	String	The Title of the CRMActivityField.
UpdatedAt	Datetime	The UpdatedAt of the CRMActivityField.
Value	String	The Value of the CRMActivityField.

CRMUsers

Returns multiple crm user records.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the CRMUser.
CrmId	String	The CrmId of the CRMUser.
CreatedAt	Datetime	The CreatedAt of the CRMUser.
UpdatedAt	Datetime	The UpdatedAt of the CRMUser.
UserId	Integer	The UserId of the CRMUser.

Emails

Returns multiple email records. The records can be filtered, paged, and sorted according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the Email.
ActionId	Integer	The ActionId of the Email.
Bounced	Boolean	The Bounced of the Email.
CadenceId	Integer	The CadenceId of the Email.
ClickTracking	Boolean	The ClickTracking of the Email.
CountsAttachments	Integer	The CountsAttachments of the Email.
CountsClicks	Integer	The CountsClicks of the Email.
CountsReplies	Integer	The CountsReplies of the Email.
CountsUniqueDevices	Integer	The CountsUniqueDevices of the Email.
CountsUniqueLocations	Integer	The CountsUniqueLocations of the Email.
CountsViews	Integer	The CountsViews of the Email.
CreatedAt	Datetime	The CreatedAt of the Email.
CrmActivityId	Integer	The CrmActivityId of the Email.
HeadersBCC	String	The HeadersBCC of the Email.
HeadersCC	String	The HeadersCC of the Email.
MailingId	Integer	The MailingId of the Email.
Personalization	String	The Personalization of the Email.
RecipientId	Integer	The RecipientId of the Email.
RecipientEmailAddress	String	The RecipientEmailAddress of the Email.
SendAfter	Datetime	The SendAfter of the Email.
SentAt	Datetime	The SentAt of the Email.
Status	String	The Status of the Email.
StepId	Integer	The StepId of the Email.
UpdatedAt	Datetime	The UpdatedAt of the Email.
UserId	Integer	The UserId of the Email.
ViewTracking	Boolean	The ViewTracking of the Email.

EmailTemplateAttachments

Returns multiple email template attachment records. The records can be filtered and paged according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the EmailTemplateAttachments.
AttachmentId	Integer	The AttachmentId of the EmailTemplateAttachments.
EmailTemplateId	Integer	The EmailTemplateId of the EmailTemplateAttachments.
Name	String	The Name of the EmailTemplateAttachments.
DownloadURL	String	The DownloadURL of the EmailTemplateAttachments.
AttachmentFileSize	Integer	The AttachmentFileSize of the EmailTemplateAttachments.

EmailTemplates

Returns multiple email template records. The records can be filtered, paged, and sorted according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the EmailTemplate.
LinksAttachments	String	The LinksAttachments of the EmailTemplate.
ArchivedAt	Datetime	The ArchivedAt of the EmailTemplate.
Body	String	The Body of the EmailTemplate.
BodyPreview	String	The BodyPreview of the EmailTemplate.
CadenceTemplate	Boolean	The CadenceTemplate of the EmailTemplate.
ClickTrackingEnabled	Boolean	The ClickTrackingEnabled of the EmailTemplate.
CountsBounces	Integer	The CountsBounces of the EmailTemplate.
CountsClicks	Integer	The CountsClicks of the EmailTemplate.
CountsReplies	Integer	The CountsReplies of the EmailTemplate.
CountsSentEmails	Integer	The CountsSentEmails of the EmailTemplate.
CountsViews	Integer	The CountsViews of the EmailTemplate.
CreatedAt	Datetime	The CreatedAt of the EmailTemplate.
GroupsId	Integer	The GroupsId of the EmailTemplate.
LastUsedAt	Datetime	The LastUsedAt of the EmailTemplate.
OpenTrackingEnabled	Boolean	The OpenTrackingEnabled of the EmailTemplate.
Shared	Boolean	The Shared of the EmailTemplate.
Subject	String	The Subject of the EmailTemplate.
Tags	String	The Tags of the EmailTemplate.
TeamTemplateId	String	The TeamTemplateId of the EmailTemplate.
TemplateOwnerId	Integer	The TemplateOwnerId of the EmailTemplate.
Title	String	The Title of the EmailTemplate.
UpdatedAt	Datetime	The UpdatedAt of the EmailTemplate.
LinkedToTeamTemplate	Boolean	The LinkedToTeamTemplate property of the EmailTemplates table.
TagIDs	String	The TagIDs property of the EmailTemplates table.
Search	String	The Search property of the EmailTemplates table.
FilterByOwner	Boolean	The FilterByOwner property of the EmailTemplates table.
IncludeCadenceTemplates	Boolean	The IncludeCadenceTemplates property of the EmailTemplates table.
IncludeArchivedTemplates	Boolean	The IncludeArchivedTemplates property of the EmailTemplates table.

Groups

Returns multiple group records. The records can be filtered, and sorted according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the Group.
Name	String	The Name of the Group.
ParentId	Integer	The ParentId of the Group.

MIMEEmailPayloads

Returns the MIME content for email.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the MIMEEmailPeyload.
MailBox	String	The MailBox of the MIMEEmailPeyload.
MessageId	String	The MessageId of the MIMEEmailPeyload.
Raw	String	The Raw of the MIMEEmailPeyload.

Notes

Returns multiple note records. The records can be filtered, paged, and sorted according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the Note.
Content	String	The Content of the Note.
CreatedAt	Datetime	The CreatedAt of the Note.
UpdatedAt	Datetime	The UpdatedAt of the Note.
UserId	Integer	The UserId of the Note.
AssociatedWithId	Integer	The AssociatedWithId of the Note.
CallId	Integer	The CallId of the Note.
AssociatedWithType	String	The AssociatedWithType property of the Note table.

PersonStages

Returns multiple person stage records. The records can be filtered, paged, and sorted according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the AccountStage.
Name	String	The Name of the Account.
CreatedAt	Datetime	The CreatedAt date of the Account.
UpdatedAt	Datetime	The UpdatedAt date of the AccountStage.
Order	Integer	The Order of the Account.

Steps

Returns multiple step records. The records can be filtered, paged, and sorted according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the Stage.
CadenceId	Integer	The CadenceId of the Stage.
CreatedAt	Datetime	The CreatedAt date of the Stage.
Day	Integer	The Day of the Stage.
DetailsId	Integer	The DetailsId of the Stage.
Disabled	Boolean	The Disabled of the Stage.
DisplayName	String	The DisplayName of the Stage.
StepNumber	Integer	The StepNumber of the Stage.
Type	String	The Type of the Stage.
UpdatedAt	Datetime	The UpdatedAt date of the Stage.
HasDueActions	Boolean	The HasDueActions property of the Steps table.

Successes

Returns multiple success records. The records can be filtered, paged, and sorted according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the Success.
TotalCalls	Integer	The TotalCalls of the Success.
TotalEmails	Integer	The TotalEmails of the Success.
TotalOtherTouches	Integer	The TotalOtherTouches of the Success.
CreatedAt	Datetime	The CreatedAt of the Success.
LatestActionId	Integer	The LatestActionId of the Success.
LatestCadenceId	Integer	The LatestCadenceId of the Success.
LatestCallId	Integer	The LatestCallId of the Success.
LatestEmailId	Integer	The LatestEmailId of the Success.
PersonId	Integer	The PersonId of the Success.
SucceededAt	Datetime	The SucceededAt of the Success.
SuccessWindowStartedAt	Datetime	The SuccessWindowStartedAt of the Success.
UpdatedAt	Datetime	The UpdatedAt of the Success.
UserId	Integer	The UserId of the Success.

Team

Returns the team of the authenticated user.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the Team.
AllowAutomatedEmailSteps	Boolean	The AllowAutomatedEmailSteps setting of the Team.
CallRecordingDisabled	Boolean	The CallRecordingDisabled setting of the Team.
ClickTrackingDefault	Boolean	The ClickTrackingDefault setting of the Team.
CreatedAt	Datetime	The CreatedAt date of the Team.
CustomTrackingDomain	String	The CustomTrackingDomain setting of the Team.
DispositionsRequired	Boolean	The DispositionsRequired setting of the Team.
EmailDailyLimit	Integer	The EmailDailyLimit setting of the Team.
GroupPrivacySetting	String	The GroupPrivacySetting setting of the Team.
LicenseLimit	Integer	The LicenseLimit setting of the Team.
LocalDialEnabled	Boolean	The LocalDialEnabled setting of the Team.
Name	String	The Name of the Team.
Plan	String	The Plan of the Team.
OpportunityManagement	String	The OpportunityManagement setting of the Team.
RecordByDefault	Boolean	The RecordByDefault setting of the Team.
SentimentsRequired	Boolean	The SentimentsRequired setting of the Team.
TeamVisibilityDefault	String	The TeamVisibilityDefault setting of the Team.
UpdatedAt	Datetime	The UpdatedAt date of the Team.

TeamTemplateAttachments

Returns multiple team template attachment records. The records can be filtered and paged according to the respective parameters.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the Team Template Attachments.
AttachmentFileSize	Integer	The Attachment File Size of a Team Template Attachments.
AttachmentId	Integer	The AttachmentId of a Team Template Attachments.
DownloadUrl	String	The DownloadUrl of a Team Template Attachments.
Name	String	The Name of a Team Template Attachments.
TeamTemplateId	Integer	The Team Template Id of a Team Template Attachments.

TeamTemplates

Fetches multiple team template records. The records can be filtered, paged, and sorted according to the respective parameters. Team templates are templates that are available team-wide. Admins may use team templates to create original content for the entire team, monitor version control to ensure templates are always up to date, and track template performance across the entire organization. All metrics on a team template reflect usage across the team; individual metrics can be found with the email_templates API endpoint.

Columns


Name	Type	Description
Id [KEY]	String	The Id of the AccountStage.
Attachments	String	The Attachments of the TeamTemplate.
ArchivedAt	Datetime	The ArchivedAt of the TeamTemplate.
Body	String	The Body of the TeamTemplate.
BodyPreview	String	The BodyPreview of the TeamTemplate.
ClickTrackingEnabled	Boolean	The ClickTrackingEnabled of the TeamTemplate.
Bounces	Integer	The Bounces of the TeamTemplate.
Clicks	Integer	The Clicks of the TeamTemplate.
Replies	Integer	The Replies of the TeamTemplate.
SentEmails	Integer	The SentEmails of the TeamTemplate.
Views	Integer	The Views of the TeamTemplate.
CreatedAt	Datetime	The CreatedAt of the TeamTemplate.
LastModifiedAt	Datetime	The LastModifiedAt of the TeamTemplate.
LastModifiedUserId	Integer	The LastModifiedUserId of the TeamTemplate.
LastUsedAt	Datetime	The LastUsedAt of the TeamTemplate.
OpenTrackingEnabled	Boolean	The OpenTrackingEnabled of the TeamTemplate.
Subject	String	The Subject of the TeamTemplate.
Tags	String	The Tags of the TeamTemplate.
Title	String	The Title of the TeamTemplate.
UpdatedAt	Datetime	The UpdatedAt date of the TeamTemplate.
TagId	Integer	The TagId property of the TeamTemplate table.
IncludeArchivedTemplates	Boolean	The IncludeArchivedTemplates property of the TeamTemplate table.
Search	String	The Search property of the TeamTemplate table.

Users

Returns Non Admin: Lists only your user, or all on team depending on group visibility policy Team Admin: Lists users associated with your team.

Columns


Name	Type	Description
Id [KEY]	Integer	The Id of the User.
Active	Boolean	The Active property of the User.
BCCEmailAddress	String	The BCCEmailAddress property of the User.
ClickToCallEnabled	Boolean	The ClickToCallEnabled property of the User.
CreatedAt	Datetime	The CreatedAt property of the User.
CrmConnected	Boolean	The CrmConnected property of the User.
Email	String	The Email property of the User.
EmailClientConfigured	Boolean	The EmailClientConfigured property of the User.
EmailClientEmailAddress	String	The EmailClientConfigured property of the User.
EmailSignature	String	The EmailSignature property of the User.
EmailSignatureClickTrackingDisabled	Boolean	The EmailSignatureClickTrackingDisabled property of the User.
EmailSignatureType	String	The EmailSignatureType property of the User.
FirstName	String	The FirstName property of the User.
FromAddress	String	The FromAddress property of the User.
FullEmailAddress	String	The FullEmailAddress property of the User.
GroupId	Integer	The GroupId property of the User.
Guid	String	The Guid of the User.
JobRole	String	The JobRole property of the User.
LastName	String	The LastName property of the User.
LocalDialEnabled	Boolean	The LocalDialEnabled property of the User.
Name	String	The Name of the User.
PhoneClientId	Integer	The PhoneClientId property of the User.
PhoneNumberAssignmentId	Integer	The PhoneNumberAssignmentId property of the User.
RoleId	String	The RoleId property of the User.
SendingEmailAddress	String	The SendingEmailAddress property of the User.
SlackUsername	String	The SlackUsername property of the User.
TeamId	Integer	The TeamId property of the User.
TeamAdmin	Boolean	The TeamAdmin property of the User.
TimeZone	String	The TimeZone of the User.
TwitterHandle	String	The TwitterHandle of the User.
UpdatedAt	Datetime	The UpdatedAt date of the User.
Search	String	The Search property of the Users table.
VisibleOnly	Boolean	The VisibleOnly property of the Users table.

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
AuthScheme	Whether to use APIKey Authentication or OAuth Authentication when connecting to SalesLoft.
APIKey	The API key used for accessing your SalesLoft account.

OAuth

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

SSL

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

Property	Description
LogModules	Core modules to be included in the log file.

Schema

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

Property	Description
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
AuthScheme	Whether to use APIKey Authentication or OAuth Authentication when connecting to SalesLoft.
APIKey	The API key used for accessing your SalesLoft account.

AuthScheme

Whether to use APIKey Authentication or OAuth Authentication when connecting to SalesLoft.

Remarks

OAuth: Set this to perform OAuth authentication.
APIKey: Set this to perform Token Based Authentication via the APIKey property.

APIKey

The API key used for accessing your SalesLoft account.

Remarks

The API key used for accessing your SalesLoft account.

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

OAuthClientId

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

FirewallType

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.


Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Salesloft and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

FirewallPort

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

FirewallUser

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

FirewallPassword

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

ProxyAutoDetect

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

ProxyPort

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

ProxyAuthScheme

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

BASIC: The Sync App performs HTTP BASIC authentication.
DIGEST: The Sync App performs HTTP DIGEST authentication.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

ProxyPassword

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

ProxySSLType

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:


AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
LogModules	Core modules to be included in the log file.

LogModules

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\SalesLoft Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

MaxRows

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting


DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

Each root element defines the name of a view.
Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Accounts WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"