接続の確立

Sync App アプリケーションの接続ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Salesloft への接続を作成します。Salesloft アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからSalesloft コネクタをダウンロードおよびインストールします。

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

Salesloft への接続

Salesloft はOAuth およびAPI キー認証標準を利用しています。OAuth では認証するユーザーにブラウザでSalesloft との通信を要求します。下記で説明するとおり、本プロバイダーはさまざまな方法でこれをサポートします。

Salesloft アカウントの認証

OAuth

OAuth で認証するには、OAuth アプリを作成する必要があります。手順については、カスタムOAuth アプリの作成を参照してください。

API キー

または、APIKey で認証します。Salesloft ユーザーインターフェース：https://accounts.salesloft.com/oauth/applications/ で、API キーをプロビジョニングします。

リクエストを発行し、使用するキーを受け取ります。

データモデル

概要

このセクションでは、利用可能なAPI オブジェクトを示し、Salesloft API へのSQL の実行について詳しく説明します。

主要機能

Sync App はAccounts、People、Tasks などのSalesloft エンティティをリレーショナルビューとしてモデル化し、SQL を記述してSalesloft データをクエリできるようにします。
ストアドプロシージャを使用するとSalesloft の操作を実行できます。
これらのオブジェクトへのライブ接続により、Sync App を使用するとSalesloft アカウントへのあらゆる変更が即座に反映されます。

ビュー

ビューでは、利用可能なビューを説明します。ビューは、AccountStages、AccountTiers、Actions などを静的にモデル化するように定義されています。

テーブル

テーブルでは、利用可能なテーブルを説明します。テーブルはAccounts、People、Imports、Tasks などを静的にモデル化するように定義されています。

ストアドプロシージャ

ストアドプロシージャは、Salesloft のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、Salesloft の操作を実行できます。

テーブル

Sync App はSalesloft のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。

一般的には、Salesloft テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。

Salesloft Connector for CData Sync テーブル


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.

ビュー

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

Salesloft Connector for CData Sync ビュー


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.

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

プロパティ	説明
AuthScheme	Whether to use APIKey Authentication or OAuth Authentication when connecting to SalesLoft
APIKey	The API key used for accessing your SalesLoft account.

OAuth

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

プロパティ	説明
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

解説

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.

解説

The API key used for accessing your SalesLoft account.

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

OAuthClientId

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuthClientSecret

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

SSLServerCert

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：


説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

FirewallType

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。


タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はSalesloft への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

FirewallServer

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

FirewallPort

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

FirewallUser

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

FirewallPassword

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyPort

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

BASIC： Sync App はHTTP BASIC 認証を行います。
DIGEST： Sync App はHTTP DIGEST 認証を行います。
NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyUser

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyPassword

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxySSLType

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。


AUTO	デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

LogModules

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログページを参照してください。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\SalesLoft Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

BrowsableSchemas

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、パフォーマンスが向上します。

Tables

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Views

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

MaxRows

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

Other

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット


DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

PseudoColumns

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

Timeout

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

UserDefinedViews

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

各ルートエレメントはビューの名前を定義します。
各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

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

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

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