The CData Sync App provides a straightforward way to continuously pipeline your Salesloft data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Salesloft connector can be used from the CData Sync application to pull data from Salesloft and move it to any of the supported destinations.
The Sync App leverages the Salesloft API to enable bidirectional access to Salesloft.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
To enable OAuth authentication from either embedded or custom OAuth credentials, you must set AuthScheme to OAuth.
The following subsections describe how to authenticate to Salesloft from:
For information about how to create a custom OAuth application for connecting over the Web, and why you might want to create one even for auth flows that have embedded OAuth credentials, see Creating a Custom OAuth Application.
For a complete list of connection string properties available in Salesloft, see Connection.
When the access token expires, the Sync App refreshes it automatically.
Automatic refresh of the OAuth access token:
To have the Sync App automatically refresh the OAuth access token, do the following:
Manual refresh of the OAuth access token:
The only value needed to manually refresh the OAUth access token is the OAuth refresh token.
Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
This section shows the available API objects and provides more information on executing SQL to Salesloft APIs.
Views describes the available views. Views are statically defined to model AccountStages, AccountTiers,Actions, etc.
Tables describes the available tables. Tables are statically defined to model Accounts, People, Imports, Tasks, etc.
Stored Procedures are function-like interfaces to Salesloft. Stored procedures allow you to execute operations to Salesloft, including downloading documents and moving envelopes.
The Sync App models the data in Salesloft as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Accounts | Create, update, and query the available accounts in SalesLoft. |
| 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. |
| CalendarEvents | Returns all calendar events, paginated and filtered by the date. |
| Calls | Returns multiple call records. The records can be filtered, paged, and sorted according to the respective parameters. |
| CustomFields | Fetches multiple custom field records. The records can be filtered, paged, and sorted according to the respective parameters. |
| ExternalIdConfigurations | Creates, deletes and lists all configurations for a team. |
| ExternalIdMappings | Creates, deletes and lists all mappings for a team. |
| Imports | Create, update, and query the available Imports in SalesLoft. |
| Meetings | Fetches multiple meeting records. The records can be filtered, paged, and sorted according to the respective parameters. Meetings resource is responsible for events created via the Salesloft platform using calendaring features. These events can relate to cadences, people, and accounts.. |
| MeetingSettings | Fetches multiple meeting setting records. The records can be filtered, paged, and sorted according to the respective parameters. |
| Notes | Returns multiple note records. The records can be filtered, paged, and sorted according to the respective parameters. |
| OpportunityPeople | Creates, deletes and lists associations between Salesloft people and opportunities that have been created by Salesloft or created via API. |
| OpportunityStages | Creates, Updates, deletes and lists Opportunity Stages synced from the CRM and created via API. |
| PendingEmails | Fetches a list of emails ready to be sent by an external email service. |
| People | Create, update, and query the available people in SalesLoft. |
| PersonStages | Returns multiple person stage records. The records can be filtered, paged, and sorted according to the respective parameters. |
| PlayRegistrations | Creates, Updates, deletes and lists all Play Registrations created by owner of associated integration. |
| SavedListViews | Create, update, and query the available saved list views in SalesLoft. |
| SignalRegistrations | Create, update, and query all the Signal Registrations for all Integrations. |
| Tasks | Create, update, and query the available task records in SalesLoft. |
| WebhookSubscriptions | Fetches all of the customer webhook subscriptions for your application. |
Create, update, and query the available accounts in SalesLoft.
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.
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.
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
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
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 )
In order to delete an Account the ID needs to be specified, for ex.:
DELETE FROM Accounts WHERE ID = 100
| 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 | False |
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 | String | 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. |
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.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | True |
The Id of the CadenceMembership. |
| AddedAt | Datetime | True |
The AddedAt property of the CadenceMembership table. |
| CadenceId | Integer | False |
The CadenceId property of the CadenceMembership table. |
| CountsBounces | Integer | True |
The CountsBounces property of the CadenceMembership table. |
| CountsCalls | Integer | True |
The CountsCalls property of the CadenceMembership table. |
| CountsClicks | Integer | True |
The CountsClicks property of the CadenceMembership table. |
| CountsReplies | Integer | True |
The CountsReplies property of the CadenceMembership table. |
| CountsSentEmails | Integer | True |
The CountsSentEmails property of the CadenceMembership table. |
| CountsViews | Integer | True |
The CountsViews property of the CadenceMembership table. |
| CreatedAt | Datetime | True |
The CreatedAt property of the CadenceMembership table. |
| CurrentState | String | True |
The CurrentState property of the CadenceMembership table. |
| CurrentlyOnCadence | Boolean | True |
The CurrentlyOnCadence property of the CadenceMembership table. |
| LatestActionId | Integer | True |
The LatestActionId property of the CadenceMembership table. |
| PersonId | Integer | False |
The PersonId property of the CadenceMembership table. |
| PersonDeleted | Boolean | True |
The PersonDeleted property of the CadenceMembership table. |
| UpdatedAt | Datetime | True |
The UpdatedAt property of the CadenceMembership table. |
| UserId | Integer | False |
The UserId property of the CadenceMembership table. |
| StepId | Integer | False |
ID of the step on which the person should start the cadence. Start on first step is the default behavior without this parameter. This is an Insert-only field. |
| TaskId | Integer | False |
ID of the task that causes the requested action. The task will be completed automatically upon success. This is an Insert-only field. |
Returns all calendar events, paginated and filtered by the date.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The Id of the CalendarEvent. |
| UpdatedAt | Datetime | False |
Last modification time of the calendar event. |
| UserGuid | String | False |
The UUID of the user this activity is for. |
| Title | String | False |
Title of the calendar event. |
| TenantId | Integer | False |
The Tenant ID of the user calendar. |
| Status | String | False |
The Status of the Email. The allowed values are confirmed, tentative, cancelled. |
| StartTime | Datetime | False |
Start time of the meeting. |
| Recurring | Boolean | False |
Whether the calendar event is a recurring event. |
| Provider | String | False |
The provider of the calendar event. |
| Organizer | String | False |
The organizer email of the calendar event. |
| Location | String | False |
The Location of the calendar event. |
| ICalUid [KEY] | String | False |
The Calendar event unique identifier (iCalUID). |
| HtmlLink | String | False |
Raw body content from Microsoft calendar events. |
| BodyHtml | String | False |
An absolute link to this calendar event in the Google Calendar Web UI. |
| ExtendedProperties | String | False |
Extended properties of the calendar event. |
| EndTime | Datetime | False |
The (exclusive) end time of the calendar event. |
| Description | String | False |
Description of the calendar event. |
| Creator | String | False |
The creator email of the calendar event. |
| CreatedAt | Datetime | False |
The CreatedAt of the Email. |
| ConferenceData | String | False |
The conference-related information, such as details of a Google Meet conference. |
| CanceledAt | Datetime | False |
The canceled date of the calendar event. |
| CalendarId [KEY] | String | False |
Calendar ID of the user calendar. |
| Busy | Boolean | False |
Busy/free status of the calendar event. |
| Attendees | String | False |
The attendees of the calendar event. |
| AllDay | Boolean | False |
Whether the calendar event is an all-day event. |
Returns multiple call records. The records can be filtered, paged, and sorted according to the respective parameters.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
The Id of the Call. |
| ActionId | Integer | False |
The ActionId of the Call. |
| CadenceId | Integer | False |
The CadenceId of the Call. |
| CalledPersonId | Integer | False |
The CalledPersonId of the Call. |
| CreatedAt | Datetime | False |
The CreatedAt of the Call. |
| CrmActivityId | Integer | False |
The CrmActivityId of the Call. |
| Disposition | String | False |
The Disposition of the Call. |
| Duration | Integer | False |
The Duration of the Call. |
| NoteId | Integer | False |
The NoteId of the Call. |
| Recordings | String | False |
The Recordings of the Call. |
| Sentiment | String | False |
The Sentiment of the Call. |
| StepId | Integer | False |
The StepId of the Call. |
| To | String | False |
The To of the Call. |
| UpdatedAt | Datetime | False |
The UpdatedAt of the Call. |
| UserId | Integer | False |
The UserId of the Call. |
| PersonId | String | False |
The PersonId property of the Calls table. |
| LinkedCallDataRecordIds | String | False |
CallDataRecord associations that will become linked to the created call. It is possible to pass multiple CallDataRecord ids in this field; this can be used to represent multiple phone calls that made up a single call.Any call data record that is used must not already be linked to a call. It is not possible to link a call data record to multiple calls, and it is not possible to re-assign a call data record to a different call.* Only single values are supported with our |
| UserGuid | String | False |
The UserGuid property of the Calls table. |
Fetches multiple custom field records. The records can be filtered, paged, and sorted according to the respective parameters.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | True |
The ID of Custom Field. |
| Name | String | False |
The Name of the Custom Field. |
| FieldType | String | False |
Type of the Custom Field. Value must be one of: person, company, opportunity. The allowed values are person, company, opportunity. |
| ValueType | String | True |
Value Type of the Custom Field. Value must be one of: text, date. The allowed values are text. |
| CreatedAt | Datetime | True |
The Datetime of when the Custom Field was created |
| UpdatedAt | Datetime | True |
The Datetime of when the Custom Field was last updated. |
Creates, deletes and lists all configurations for a team.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
ID of the configuration. |
| SourceType | String | False |
The type of source that owns the configuration if applicable. |
| SourceId | Integer | False |
The ID of the source integration if applicable. |
| ObjectType | String | False |
The Salesloft object that should be associated with the external type. |
| ExternalType | String | False |
The type of external. |
| Deleted | Boolean | False |
Whether or not the configuration is deleted. The allowed values are true, false. |
Creates, deletes and lists all mappings for a team.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
ID of the mapping. |
| ObjectType | String | False |
The type of object in SalesLoft. |
| ObjectId | Integer | False |
The id of the object in SalesLoft. |
| InsertedAt | Datetime | False |
When this mapping was inserted. |
| TenantId | Integer | False |
The ID of tenant. |
| ExternalType | String | False |
The type of external. |
| ExternalId | String | False |
The External ID. |
| Deleted | Boolean | False |
Whether or not the mapping is deleted. The allowed values are true, false. |
Create, update, and query the available Imports in SalesLoft.
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.
SELECT * FROM Imports WHERE Id IN (1234, 4321)
SELECT * FROM Imports WHERE UserIDs IN (123, 321)
To add an Import UserId and Name need to be specified.
INSERT INTO Imports (UserId, Name)
VALUES (123, 'ImportTest')
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
In order to delete an Import the Id needs to be specified, for ex.
DELETE FROM Imports WHERE Id = 100
| 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. |
| UserID | Integer | False |
The ID of the user who created the import. |
Fetches multiple meeting records. The records can be filtered, paged, and sorted according to the respective parameters. Meetings resource is responsible for events created via the Salesloft platform using calendaring features. These events can relate to cadences, people, and accounts..
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
The Id of the meeting. |
| Title | String | False |
Title of the meeting. |
| StartTime | Datetime | False |
Start time of the meeting. |
| EndTime | Datetime | False |
End time of the meeting. |
| CalendarId | String | False |
Calendar ID of the meeting owner. |
| CalendarType | String | False |
Calendar type of the meeting owner. Possible values are: gmail, azure, nylas, linkedin_azure, cerebro, external. The allowed values are gmail, azure, nylas, linkedin_azure, cerebro, external. |
| MeetingType | String | False |
Meeting type. |
| RecipientName | String | False |
Name of the meeting invite recipient. |
| RecipientEmail | String | False |
Email of the meeting invite recipient. |
| Location | String | False |
Location of the meeting. |
| Description | String | False |
Description of the meeting. |
| EventId | String | False |
ID of the meeting created by target calendar. |
| AccountId | String | False |
ID of the account the recipient associated to. |
| TaskId | String | False |
ID of the created task. |
| CreatedAt | Datetime | False |
Datetime of when the meeting was created. |
| UpdatedAt | Datetime | False |
Datetime of when the meeting was last updated. |
| Guests | String | False |
The list of attendees emails of the meeting. |
| Attendees | String | False |
The attendees of the meeting. Each attendee includes the following fields: status, email, name, organizer. |
| Person | String | False |
The Salesloft Person Id for the recipient. |
| Cadence | String | False |
The Salesloft Cadence Id associated with meeting. |
| Step | String | False |
The Salesloft Step Id associated with meeting. |
| BookedByUser | String | False |
The User who booked the meeting. |
| CrmReferences | String | False |
The List of crm references associated with the meeting. |
| EventSource | String | False |
Source of the meeting. Possible values are: 'external' - The event was synced to Salesloft platform via Calendar Sync, 'internal' - The event was created via Salesloft platform. |
| CanceledAt | Datetime | False |
Datetime of when the meeting was canceled. |
| AllDay | Boolean | False |
Whether the meeting is an all-day meeting. |
| NoShow | Boolean | False |
Whether the meeting is a No Show meeting. |
| CrmCustomFields | String | False |
The List of crm custom fields which will be logged to SFDC. |
| StrictAttribution | Boolean | False |
Strict attribution means that we 100% sure which cadence generate the meeting. |
| ICalUid | String | False |
The UID of the meeting provided by target calendar provider. |
| Status | String | False |
The Status of the meeting. Possible values are: pending, booked, failed, retry. The allowed values are pending, booked, failed, retry. |
| RescheduleStatus | String | False |
The Status of the meeting rescheduling progress. Possible values are: pending, booked, failed, retry. |
| OwnedByMeetingsSettings | String | False |
The Owner meetings settings. |
| BookedByMeetingsSettings | String | False |
The Organizer meetings settings. |
| ShowDeleted | Boolean | False |
Whether to include deleted events in the result. |
Fetches multiple meeting setting records. The records can be filtered, paged, and sorted according to the respective parameters.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
The Id of the meeting. |
| UserId | String | False |
The Id of the User of the meeting. |
| UserSlug | String | False |
The User slug generated with a full name of the user. |
| PrimaryCalendarId | String | False |
The ID of the primary calendar. |
| PrimaryCalendarName | String | False |
The Display name of the primary calendar. |
| EmailAddress | String | False |
The Calendar owner's email address. |
| UserDetails | String | False |
The User details. |
| CalendarType | String | False |
Calendar type of the meeting owner. Possible values are: gmail, azure, nylas, linkedin_azure, cerebro, external. The allowed values are gmail, azure, nylas, linkedin_azure, cerebro, external. |
| Title | String | False |
Title of the meeting. |
| Description | String | False |
Description of the meeting. |
| Location | String | False |
Location of the meeting. |
| DefaultMeetingLength | Integer | False |
Default meeting length in minutes set by the user. |
| AvailabilityLimitEnabled | Boolean | False |
If Availability Limits have been turned on. |
| AvailabilityLimit | Integer | False |
The number of days out the user allows a prospect to schedule a meeting. |
| ScheduleDelay | Integer | False |
The number of hours in advance a user requires someone to a book a meeting with them. |
| BufferTimeDuration | Integer | False |
Default buffer duration in minutes set by a user. |
| ScheduleBufferEnabled | Boolean | False |
Determines if meetings are scheduled with a 15 minute buffer between them. |
| TimesAvailable | String | False |
Times available set by a user that can be used to book meetings. |
| AllowBookingOnBehalf | Boolean | False |
Allow other team members to schedule on you behalf. |
| AllowBookingOvertime | Boolean | False |
Allow team members to insert available time outside your working hours. |
| AllowEventOverlap | Boolean | False |
Allow team members to double book events on your calendar. |
| ShareEventDetail | Boolean | False |
Allow team members to see the details of events on your calendar. |
| EnableDynamicLocation | Boolean | False |
Determines if location will be filled via third-party service (Zoom, GoToMeeting, etc.). |
| CreatedAt | Datetime | False |
Datetime of when the meeting was created. |
| UpdatedAt | Datetime | False |
Datetime of when the meeting was last updated. |
| TimeZone | String | False |
Time zone for current calendar. |
| PrimaryCalendarConnectionFailed | Boolean | False |
Gets true when any issue with fetching calendar occurs. |
| EnableCalendarSync | Boolean | False |
Determines if a user enabled Calendar Sync feature. |
| RescheduleMeetingsEnabled | Boolean | False |
Determines if a user enabled reschedule meetings feature. |
| ActiveMeetingUrl | String | False |
The ActiveMeetingUrl of the meeting. |
Returns multiple note records. The records can be filtered, paged, and sorted according to the respective parameters.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
The Id of the Note. |
| Content | String | False |
The Content of the Note. |
| CreatedAt | Datetime | False |
The CreatedAt of the Note. |
| UpdatedAt | Datetime | False |
The UpdatedAt of the Note. |
| UserId | Integer | False |
The UserId of the Note. |
| AssociatedWithId | Integer | False |
The AssociatedWithId of the Note. |
| CallId | Integer | False |
The CallId of the Note. |
| AssociatedWithType | String | False |
The AssociatedWithType property of the Note table. |
| SkipCRMSync | Boolean | False |
Boolean indicating if the CRM sync should be skipped. No syncing will occur if true. |
| Subject | String | False |
The subject of the note's crm activity, defaults to 'Note'. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| UserGUID | String |
The user to create the note for. Only team admins may create notes on behalf of other users. Defaults to the requesting user. |
Creates, deletes and lists associations between Salesloft people and opportunities that have been created by Salesloft or created via API.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
ID of OpportunityPerson record. |
| PersonId | Integer | False |
The ID of the Salesloft Person. |
| OpportunityId | Integer | False |
The ID of the Salesloft Opportunity. |
| OpportunityCrmId | Integer | False |
The Opportunity CRM ID. |
| PersonCrmId | String | False |
The Person CRM ID. |
| CreatedAt | Datetime | False |
Datetime of when the OpportunityPerson was created. |
| UpdatedAt | Datetime | False |
Datetime of when the OpportunityPerson was updated. |
Creates, Updates, deletes and lists Opportunity Stages synced from the CRM and created via API.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
ID of Opportunity Stage record. |
| Name | String | False |
Name of Opportunity Stage. |
| CreatedAt | Datetime | False |
Datetime of when the Opportunity Stage was created. |
| UpdatedAt | Datetime | False |
Datetime of when the Opportunity Stage was updated. |
| Order | Integer | False |
Sortable value of Opportunity Stage order. |
| Active | Boolean | False |
Flag signalizing whether the Opportunity Stage is active. |
Fetches a list of emails ready to be sent by an external email service.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
ID of the email. |
| Mailbox | String | False |
Email Address of the pending email. |
| MIMEEmailPayload | String | False |
The email MIME payload. |
| MessageId | String | False |
The message id of the email that was sent. |
| Status | String | False |
Delivery status of the email. Valid statuses are 'sent' and 'failed'. |
| ErrorMessage | String | False |
The error message indicating why the email failed to send. |
| SentAt | String | False |
The time that the email was actually sent in iso8601 format. |
Create, update, and query the available people in SalesLoft.
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.
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'
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
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
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')
In order to delete a Person, the Id needs to be specified.
DELETE FROM People WHERE Id = 100
| 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 | String | 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. |
Returns multiple person stage records. The records can be filtered, paged, and sorted according to the respective parameters.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
The Id of the AccountStage. |
| Name | String | False |
The Name of the Account. |
| CreatedAt | Datetime | False |
The CreatedAt date of the Account. |
| UpdatedAt | Datetime | False |
The UpdatedAt date of the AccountStage. |
| Order | Integer | False |
The Order of the Account. |
Creates, Updates, deletes and lists all Play Registrations created by owner of associated integration.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
ID of Play Registration. |
| State | String | False |
State of play registration, either 'draft' or 'enabled'. 'draft' means Play is only available to your team and Play can be updated as needed. 'enabled' means Play is available to all teams, and only certain properties of the Play (name, label, etc.) can be updated. |
| SignalType | String | False |
The Signal Type. |
| SignalRegistration | String | False |
The Associated signal registration. |
| OwnerUserGuid | String | False |
The User GUID of Play Registration owner. |
| OwnerTenantId | Integer | False |
The Tenant ID of Play Registration owner. |
| Name | String | False |
Localized mapping of the Play Registration's name, which is displayed as a title for the Play. |
| Label | String | False |
The Localized mapping of the Play Registration's label, which provides a short description used to explain the signal action combination. |
| Integration | String | False |
Associated integration. |
| Indicators | String | False |
List of Play Indicators. Come from Signal Registration Indicators. An Indicator set by a Play must be a part of its Signal Registration i.e. if this Indicator is present, then that Play will execute. |
| Identifier | String | False |
Play Identifier. |
| EnabledAt | Datetime | False |
ISO8601 timestamp of when play registration was enabled. |
| Description | String | False |
Localized mapping of the Play Registration's description, which provides a more detailed description of the signal action combination. |
| CreatedAt | Datetime | False |
ISO8601 timestamp of when play registration was created. |
| Attributes | String | False |
Describe the Task that will get generated, when it will be due, and instructions/template provided to the seller at execution time. (If task_type is email, then you can optionally set an email_subject and email_body.) |
Create, update, and query the available saved list views in SalesLoft.
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.
SELECT * FROM SavedListViews WHERE Id = 123
SELECT * FROM SavedListViews WHERE View = 'people'
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)
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
In order to delete a SavedListViews the Id needs to be specified.
DELETE FROM SavedListViews WHERE Id = 123
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
The Id of the Stage. |
| View | String | False |
The View of the Stage. The allowed values are people, companies, recordings. |
| 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. |
Create, update, and query all the Signal Registrations for all Integrations.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
The Id of the Registration. |
| Type | String | False |
Signal registration type. |
| SignalName | String | False |
Signal name. |
| OwnerUserGuid | String | False |
User GUID of the Registration owner. |
| IntegrationSlug | String | False |
Integration Slug linked to the signal registration. |
| Integration | String | False |
Integration linked to signal registration. |
| IntegrationId | Integer | False |
IntegrationId linked to signal registration. |
| Indicators | String | False |
Array of signal indicators registrations. |
| GloballyInstalledAt | Datetime | False |
ISO8601 timestamp of when the registration was globally installed. |
| Description | String | False |
Localized signal description. |
| DataShape | String | False |
JSON schema of the signal data. |
| Attribution | String | False |
Array of possible attributions. |
| CreatedAt | Datetime | True |
ISO8601 timestamp of when the signal registration was created. |
| UpdatedAt | Datetime | True |
The UpdatedAt of the Registration. |
Create, update, and query the available task records in SalesLoft.
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.
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'
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')
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
In order to delete a Task the Id needs to be specified, for ex.
DELETE FROM Tasks WHERE Id = 100
| 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. The allowed values are scheduled, completed. |
| 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. The allowed values are call, email, general, integration. |
| 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. The allowed values are overdue, today, tomorrow, this_week, next_week. |
| IdempotencyKey | String | False |
The IdempotencyKey property of the Task table. |
| IntegrationId | Long | False |
The IntegrationId property of the Task table. |
| IntegrationName | String | False |
The IntegrationName property of the Task table. |
| IntegrationStepId | String | False |
The IntegrationStepId property of the Task table. |
| IntegrationTaskId | String | False |
The IntegrationTaskId property of the Task table. |
| IntegrationTaskTypeLabel | String | False |
The IntegrationTaskTypeLabel property of the Task table. |
Fetches all of the customer webhook subscriptions for your application.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
ID for the Webhook Subscription. |
| UserGUID | String | False |
UUID of the user the token is associated with. |
| TenantId | Integer | False |
ID for the tenant to which user is assigned. |
| EventType | String | False |
Type of event the subscription is for. |
| Enabled | Boolean | False |
Is the Webhook Subscription enabled or not. |
| CallbackUrl | String | False |
URL for your callback handler. |
| CallbackToken | String | False |
SalesLoft will include this token in the webhook event payload when calling your callback_url. It is strongly encouraged for your handler to verify this value in order to ensure the request came from SalesLoft. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| 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. |
| ActivityHistories | Fetches all of the customer's past activities for your application. Returns all the Activities that are found on the Salesloft Activity Feed. |
| Cadences | Returns multiple cadence records. The records can be filtered, paged, and sorted according to the respective parameters. |
| CadenceStats | Fetches stats for a cadence, by ID only. |
| 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. |
| 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. |
| CallsInstructions | Fetches multiple call instruction records. |
| Conversations | Fetches multiple conversations. |
| CRMAccountTeamMemberRoles | Fetches multiple CRM Account Team Member Role records. |
| CRMAccountTeamMembers | Fetches multiple CRM Account Team Member records. |
| 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. |
| Opportunities | Lists multiple Opportunity records. Returns Opportunity records synced from the CRM and created via API. The records can be filtered, paged, and sorted using the parameters below and external ID parameters. |
| PhoneNumberAssignments | Fetches multiple phone number assignment records. The records can be filtered, paged, and sorted according to the respective parameters. |
| Profiles | Authenticated user's integrations authorization data. |
| RecordingSettings | Fetches the recording status for a given phone number, based on Do Not Record and Recording Governance for your team. Phone number should be in E.164 format. |
| Requests | Query Requests by some given filters. |
| Roles | Fetches multiple custom role records. The records can be filtered, and sorted according to the respective parameters. A custom role is any role that is not Admin or User. |
| 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. |
| TasksStatistics | Fetches task counts data grouped by the task type. |
| 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. |
| Transcriptions | List Conversation Transcriptions. |
| TranscriptionsArtifact | Fetches a Conversation Transcription Artifact. |
| TranscriptionsSentences | Fetches a Conversation Transcription's sentence data. |
| 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. |
Returns multiple account stage records. The records can be filtered, paged, and sorted according to the respective parameters.
| 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. |
Returns multiple account tier records. The records can be filtered, paged, and sorted according to the respective parameters.
| 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. |
Returns multiple call instruction records. The records can be filtered, paged, and sorted according to the respective parameters.
| 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. |
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.
| 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. |
Fetches all of the customer's past activities for your application. Returns all the Activities that are found on the Salesloft Activity Feed.
| Name | Type | Description |
| Id [KEY] | String | The Id of the Action. |
| UserGuid | String | The UUID of the user this activity is for. |
| UpdatedAt | Datetime | When this record was updated. |
| Type | String | The Type of the Activity. Filter by the type of activity. Must be one of: added_to_cadence, completed_action, call, requested_email, sent_email, received_email, email_reply, note, success, dnc_event, residency_change, meeting, meeting_held, message_conversation, task, voicemail, opportunity_stage_change, opportunity_amount_change, opportunity_close_date_change. |
| StaticData | String | The static data for this activity. |
| DynamicData | String | Attributes from associated records. This is specific to the type of activity and may change over time. Not returned for create requests. |
| FailedDynamicResources | String | A list of remote resource names that failed to load. This is specific to the type of activity and may change over time. Not returned for create requests. |
| ResourceType | String | Type of the resource this activity is for. One of: account, person. |
| ResourceId | Integer | ID of the resource this activity is for. It will be a string for the following resource types: crm_opportunity. |
| PinnedAt | Datetime | When this record was pinned. |
| OccurredAt | Datetime | When this activity occurred. |
| CreatedAt | Datetime | When this record was created. |
| Pinned | Boolean | Filter by the pinned status of activity. Must be 'true' or 'false'. |
Returns multiple cadence records. The records can be filtered, paged, and sorted according to the respective parameters.
| 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. |
Fetches stats for a cadence, by ID only.
| Name | Type | Description |
| Id [KEY] | Integer | The ID of the Cadence. |
| CreatedAt | Datetime | The datetime of when the cadence was created. |
| UpdatedAt | Datetime | The datetime of when the cadence was updated. |
| ArchivedAt | Datetime | The datetime of when the cadence was archived. |
| LatestActiveDate | Datetime | The Date of when the cadence was last used. |
| TeamCadence | Boolean | Whether this cadence is a team cadence. A team cadence is created by an admin and can be run by all users. |
| Shared | Boolean | Whether this cadence is visible to team members (shared). |
| Archived | Boolean | Whether this cadence is archived. |
| RemoveBouncesEnabled | Boolean | Whether this cadence is configured to automatically remove people who have bounced. |
| RemoveRepliesEnabled | Boolean | Whether this cadence is configured to automatically remove people who have replied. |
| OptOutLinkIncluded | Boolean | Whether this cadence is configured to include an opt-out link by default. |
| Draft | Boolean | Whether this cadence is in draft mode. |
| OverrideContactRestrictions | Boolean | Whether this cadence is an Operational Cadence. An operational cadence is only created by an admin and accounts with the correct permission. |
| CadenceFrameworkId | Integer | ID of the cadence framework used to create steps for the cadence. |
| ArchivedBy | String | Name or email of the user who archived the cadence. |
| CadenceFunction | String | The use case of the cadence. Possible values are: outbound - Denotes an outbound cadence, typically for sales purposes; inbound - Denotes an inbound sales cadence; event - Denotes a cadence used for an upcoming event; other - Denotes a cadence outside of the standard process. |
| Name | String | The Cadence name. |
| ExternalIdentifier | String | The Cadence External ID. |
| Tags | String | All tags applied to this cadence. |
| CurrentState | String | The state of the Cadence. Read Only. Valid states are: draft, active, archived, expired, deleted. |
| CreatorId | Integer | The User that created this cadence. |
| OwnerId | Integer | The User that is marked as the owner of this cadence. |
| BouncedStage | Integer | The Stage set when person on cadence bounces. |
| BouncedCount | Integer | The BouncedCount of the Cadence. |
| RepliedStage | Integer | The Stage set when person on cadence replies. |
| AddedStage | Integer | The Stage set when person is added to cadence. |
| FinishedStage | Integer | The Stage set when person is finished with cadence. |
| CadencePriority | Integer | The Priority of the cadence. |
| CadencePeopleCounts | Integer | The number of people that have ever been added to the cadence. |
| CadenceDuration | Integer | The CadenceDuration of the Cadence. |
| PeopleActedOnCountCounts | Integer | The number of people that have been skipped, scheduled, or advanced in a cadence. |
| TargetDailyPeopleCounts | Integer | The user defined target for number of people to add to the cadence each day. |
| OpportunitiesCreatedCounts | Integer | The number of opportunities created and attributed to the cadence. |
| OpportunitiesCreatedRate | String | The rate of opportunities created and attributed to the cadence. |
| MeetingsBookedCounts | Integer | The number of meetings booked and attributed to the cadence. |
| MeetingsBookedRate | String | The rate of meetings booked and attributed to the cadence. |
| OutcomeAttributionEnabled | Integer | The OutcomeAttributionEnabled of the Cadence. |
| PeopleActedOnCount | Integer | The PeopleActedOnCount of the Cadence. |
| RepliedCount | Integer | The RepliedCount of the Cadence. |
| RepliedRate | String | The RepliedRate of the Cadence. |
| SentEmailsCount | Integer | The SentEmailsCount of the Cadence. |
| StepGroupCount | Integer | The StepGroupCount of the Cadence. |
| ViewedCount | Integer | The ViewedCount of the Cadence. |
| ViewedRate | String | The ViewedRate of the Cadence. |
| InProgressPeopleCount | Integer | The InProgressPeopleCount of the Cadence. |
| DueActionCount | Integer | The DueActionCount of the Cadence. |
| DeliveredCount | Integer | The DeliveredCount of the Cadence. |
| ClickedCount | Integer | The ClickedCount of the Cadence. |
| ClickedRate | String | The ClickedRate of the Cadence. |
| CallsCount | Integer | The CallsCount of the Cadence. |
| Groups | String | The Groups to which this cadence is assigned, if any. |
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.
| 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. |
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.
| 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. |
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.
| 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. |
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.
| 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. |
Fetches multiple call instruction records.
| Name | Type | Description |
| Id [KEY] | Integer | ID of call instructions. |
| CreatedAt | Datetime | The datetime of when the cadence was created. |
| UpdatedAt | Datetime | The datetime of when the cadence was updated. |
| Instructions | String | The instructions. |
Fetches multiple conversations.
| Name | Type | Description |
| Id [KEY] | String | UUID of the Conversation. |
| Duration | Integer | Duration of the Conversation in milliseconds. |
| IsApi | Boolean | Determines if the channel of through this Conversation was processed. |
| Platform | String | Source of the Conversation.
The allowed values are bluejeans, gotomeeting, joinme, manual_upload, ms_teams, salesloft, uberconference, webex, zoom, google_meet, external_audio. |
| MediaType | String | Determines if conversation is video or audio.
The allowed values are audio, video. |
| OrganizationId | String | ID of the Organization. |
| Title | String | Title of the Conversation. |
| OwnerId | String | ID of the owner. |
| OwnerGUID | String | GUID of the user. |
| StartedRecordingAt | Integer | Starts of the recording in milliseconds. |
| EventEndDate | Datetime | Datetime of when the Conversation ended. The date time ISO-8601 format. |
| EventStartDate | Datetime | Datetime of when the Conversation started. The date time ISO-8601 format. |
| LanguageCode | String | The text's BCP-47 language code, such as
The allowed values are en-AU, en-AB, en-GB, en-IN, en-IE, en-NZ, en-ZA, en-US, en-WL, es-ES, es-US, nl-NL, it-IT, fr-FR, fr-CA, de-DE, de-CH. |
| CreatedAt | Datetime | Datetime of Conversation creation. The date time ISO-8601 format. |
| UpdatedAt | Datetime | Datetime of the last Conversation update. The date time ISO-8601 format |
| CallId | String | Id of the call data record. |
| AccountId | String | Reference to the Account. |
| PersonId | String | Reference to the People. |
| RecordingId | String | Reference to the Recording artifact. |
| TranscriptionId | String | Reference to the Transcription. |
| TranscriptionSentencesId | String | Reference to the Transcription sentences. |
| TranscriptionArtifactId | String | Reference to the Transcription artifact. |
Fetches multiple CRM Account Team Member Role records.
| Name | Type | Description |
| Id [KEY] | Integer | ID of CRM Account Team Member Role. |
| Name | String | Name of CRM Account Team Member Role. |
Fetches multiple CRM Account Team Member records.
| Name | Type | Description |
| Id [KEY] | Integer | ID of CRM Account Team Member. |
| CrmId | String | ID of CRM Account Team Member. |
| AccountCrmId | String | ID of CRM Account. |
| UserCrmId | String | ID of CRM User. |
| TeamMemberRole | String | Role of CRM Account Team Member. |
| AccountAccessLevel | String | Access level for Account. |
| UserCrmName | String | Name of CRM User. |
| CompanyCrmId | Integer | The crm_id of the company to fetch CRM Account Team Members for. |
Returns multiple crm activity records. The records can be filtered, paged, and sorted according to the respective parameters.
| 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. |
Returns multiple crm activity field records. The records can be filtered, paged, and sorted according to the respective parameters.
| 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. |
Returns multiple crm user records.
| 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. |
Returns multiple email records. The records can be filtered, paged, and sorted according to the respective parameters.
| 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.
The allowed values are sent, sent_from_gmail, sent_from_external, pending, pending_reply_check, scheduled, sending, delivering, failed, cancelled, pending_through_gmail, pending_through_external. |
| 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. |
Returns multiple email template attachment records. The records can be filtered and paged according to the respective parameters.
| 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. |
Returns multiple email template records. The records can be filtered, paged, and sorted according to the respective parameters.
| 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 | String | 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. |
Returns multiple group records. The records can be filtered, and sorted according to the respective parameters.
| 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. |
Returns the MIME content for email.
| Name | Type | Description |
| Id [KEY] | Integer | The Id of the Email. |
| MailBox | String | Email Address of Sender's mailbox. |
| MessageId | String | The Unique Message ID. |
| Raw | String | The Base64 encoded MIME email content. |
Lists multiple Opportunity records. Returns Opportunity records synced from the CRM and created via API. The records can be filtered, paged, and sorted using the parameters below and external ID parameters.
| Name | Type | Description |
| Id [KEY] | Integer | ID of the Opportunity. |
| Name | String | The Opportunity Name. |
| Amount | String | The Estimated total sale amount. |
| StageName | String | The Stage name. |
| Probability | String | The Probability. |
| CrmId | String | The identifier for this record in the CRM. |
| CrmType | String | The CRM type. |
| AccountCrmId | String | The Account CRM id. |
| OwnerCrmId | String | The Owner CRM id. |
| AccountName | String | The Account Full Name. |
| CreatedByCrmId | String | The Created By CRM id. |
| OpportunityType | String | The OpportunityType. |
| OwnerCrmName | String | The Owner Crm Name. |
| CrmLastUpdatedDate | Datetime | The Datetime of when the Opportunity was most recently updated in CRM. |
| CloseDate | Datetime | The Date when the opportunity is expected to close. |
| IsClosed | Boolean | Whether the opportunity is closed. |
| IsWon | Boolean | Whether the opportunity is closed won. |
| CrmUrl | Boolean | CRM url, currently Salesforce.com only. |
| CreatedAt | Datetime | The Datetime of when the Opportunity was created. |
| UpdatedAt | Datetime | The Datetime of when the Opportunity was last updated. |
| CreatedDate | Datetime | The Datetime of when the Opportunity was created in CRM. |
| OpportunityWindowPersonId | Integer | ID of when the attributed person was created in Salesloft. |
| OpportunityWindowStartedAt | Datetime | Datetime of when the attributed person was created in Salesloft. |
| CustomFields | String | Custom fields are defined by the user's team. Only fields with values are presented in the API. |
| CurrencyIsoCode | String | Currency ISO Code. |
| Tags | String | All tags applied to this Opportunities. |
| MostRecentCadenceId | Integer | The most recent cadence associated with the Opportunity. |
| MostRecentStepId | Integer | The most recent step associated with the Opportunity. |
| MostRecentStepNumber | Integer | The most recent step number associated with the Opportunity. |
| MostRecentStepAccountId | Integer | The most recent step account id associated with the Opportunity. |
| OwnerId | Integer | The owner associated with the Opportunity. |
| CreatorId | Integer | The creator associated with the Opportunity. |
| AccountId | Integer | The account that this opportunity is associated to. |
Fetches multiple phone number assignment records. The records can be filtered, paged, and sorted according to the respective parameters.
| Name | Type | Description |
| Id [KEY] | Integer | PhoneNumberAssignment ID. |
| Number | String | The phone number associated with this assignment. |
| User | String | User associated with this phone number assignment. |
Authenticated user's integrations authorization data.
| Name | Type | Description |
| GoogleDriveEmail | String | Google Meet V1 Email. |
| GoogleMeetEmail | String | Google Meet V2 Email. |
| MsTeamsEmail | String | Microsoft Teams V1 Email. |
| MsTeamsV2Email | String | Microsoft Teams V2 Email. |
| TwitterHandle | String | Twitter Handle. |
| WebexEmail | String | Webex Email. |
| ZoomEmail | String | Zoom V1 Email. |
| ZoomV2Email | String | Zoom V2 Email. |
| ConversationsZoomAdminEmail | String | Zoom Admin Email. |
Fetches the recording status for a given phone number, based on Do Not Record and Recording Governance for your team. Phone number should be in E.164 format.
| Name | Type | Description |
| Id [KEY] | String | The id of the RecordingSettings. E.164 Phone Number. |
| RecordingDefault | Boolean | Whether this phone number should record by default. |
| PartiesToRecord | String | How many parties to record. Can be one of: none, both, one |
Query Requests by some given filters.
| Name | Type | Description |
| Id [KEY] | Integer | ID of the Request. |
| TeamId | Integer | ID of the Request's target team. |
| UserGuid | String | GUID of the user who created the Request. |
| RequestType | String | Standardized type of the Request. |
| Metadata | String | Data that varies across Request types. |
| Events | String | Data that varies across Request types. |
| DryRun | Boolean | Whether or not to change data. |
Fetches multiple custom role records. The records can be filtered, and sorted according to the respective parameters. A custom role is any role that is not Admin or User.
| Name | Type | Description |
| Id [KEY] | Integer | ID of the custom role. |
| Name | String | Name of the custom role. |
Returns multiple step records. The records can be filtered, paged, and sorted according to the respective parameters.
| 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. |
Returns multiple success records. The records can be filtered, paged, and sorted according to the respective parameters.
| 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. |
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.
| Name | Type | Description |
| Id [KEY] | Integer | The Id of the Tag. |
| Name | String | The Name of the Tag. |
Fetches task counts data grouped by the task type.
| Name | Type | Description |
| TotalCallTasks [KEY] | Integer | Number of tasks with type: call. |
| TotalEmailTasks [KEY] | Integer | Number of tasks with type: email. |
| TotalGeneralTasks [KEY] | Integer | Number of tasks with type: general. |
| TotalIntegrationTasks [KEY] | Integer | Number of tasks with type: integration. |
| TotalOtherTasks [KEY] | Integer | Number of tasks with type: other. |
| TotalTasks [KEY] | Integer | Number of tasks with type: total. |
| Id [KEY] | Integer | IDs of tasks to fetch. |
| UserId [KEY] | Integer | Filters tasks by the user to which they are assigned. |
| PersonId [KEY] | Integer | Filters tasks by the person to which they are associated. |
| AccountId [KEY] | Integer | Filters tasks by the account to which they are associated. |
| CurrentState [KEY] | String | Filters tasks by the account to which they are associated. |
| TimeIntervalFilter [KEY] | String | Filters tasks by time interval. Valid time_intervals include: ['overdue', 'today', 'tomorrow', 'this_week', 'next_week'].
The allowed values are overdue, today, tomorrow, this_week, next_week. |
| CompletedTimeInterval [KEY] | String | Filters tasks by time interval. Valid time_intervals include: ['today', 'yesterday', 'this_week', 'previous_week', 'this_month'].
The allowed values are today, yesterday, this_week, previous_week, this_month. |
| IdempotencyKey [KEY] | String | Filters tasks by idempotency key. |
| Locale [KEY] | String | Filters tasks by locale of the person to which they are associated. |
| Source [KEY] | String | Filters tasks by source. |
Returns the team of the authenticated user.
| 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. |
Returns multiple team template attachment records. The records can be filtered and paged according to the respective parameters.
| 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 | String | The Team Template Id of a Team Template Attachments. |
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.
| 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 | String | 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. |
List Conversation Transcriptions.
| Name | Type | Description |
| Id [KEY] | String | Transcription Id. |
| LanguageCode | String | The text's BCP-47 language code, such as en-US or sr-Latn.
The allowed values are en-AU, en-AB, en-GB, en-IN, en-IE, en-NZ, en-ZA, en-US, en-WL, es-ES, es-US, nl-NL, it-IT, fr-FR, fr-CA, de-DE, de-CH. |
| CreatedAt | Datetime | Date transcription was created. |
| UpdatedAt | Datetime | Date transcription was updated. |
| ConversationId | String | Reference to the Conversation. |
| TranscriptionSentencesId | String | Reference to the transcription sentences. |
| TranscriptionArtifactId | String | Reference to the transcription artifact. |
Fetches a Conversation Transcription Artifact.
| Name | Type | Description |
| Id [KEY] | String | Transcription Id. |
| LanguageCode | String | The text's BCP-47 language code, such as en-US or sr-Latn. |
| Url | String | Signed Url to transcription artifact. |
| ContentType | String | Content type of transcription file. Possible values: application/json. |
| CreatedAt | Datetime | Date transcription was created. |
| UpdatedAt | Datetime | Date transcription was updated. |
| ConversationId | String | Reference to the Conversation. |
Fetches a Conversation Transcription's sentence data.
| Name | Type | Description |
| Id [KEY] | String | Transcription Id. |
| StartTime | Integer | Sentence start time. |
| EndTime | Integer | Sentence end time. |
| OrderNumber | Integer | Sentence order number. |
| RecordingAttendeeId | String | Attendee id. |
| Text | String | Sentence text. |
| ConversationId | String | Reference to the Conversation. |
Returns Non Admin: Lists only your user, or all on team depending on group visibility policy Team Admin: Lists users associated with your team.
| 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. |
| 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. |
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.
| 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. |
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| IncludeFiltersAsViews | Set this to true if you want to expose filters for the modules as views.(Also konwn as Saved List Views). |
| ImpersonatedUserId | User Impersonation allows Administrators to access and operate as if they were logged in as that User. The ImpersonatedUserId property defines the Id of the user you are trying to impersonate. The impact this has in the system is the value of the ownerId send in the insert/update statements as well as in Filters Views where the filter contains OwnerId or OwnerGUID. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
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. |
Whether to use APIKey Authentication or OAuth Authentication when connecting to SalesLoft.
The API key used for accessing your SalesLoft account.
The API key used for accessing your SalesLoft account.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
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.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: 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.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Salesloft. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Salesloft. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Salesloft. If the SOCKS 5 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.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of the proxy server that you want to route HTTP traffic through.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
The authentication type can be one of the following:
For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
The username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The user name of a user registered with the proxy server. |
| DIGEST | The user name of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.
The password associated with the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.
The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
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, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.
For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.
The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.
For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) 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, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| IncludeFiltersAsViews | Set this to true if you want to expose filters for the modules as views.(Also konwn as Saved List Views). |
| ImpersonatedUserId | User Impersonation allows Administrators to access and operate as if they were logged in as that User. The ImpersonatedUserId property defines the Id of the user you are trying to impersonate. The impact this has in the system is the value of the ownerId send in the insert/update statements as well as in Filters Views where the filter contains OwnerId or OwnerGUID. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
Set this to true if you want to expose filters for the modules as views.(Also konwn as Saved List Views).
You can query the filtered modules like you would query the views:
SELECT * FROM [Filter_People_CadenceTest]
where "People" is the name of the module and "CadenceTest" is the name of the filter applied to that module.
User Impersonation allows Administrators to access and operate as if they were logged in as that User. The ImpersonatedUserId property defines the Id of the user you are trying to impersonate. The impact this has in the system is the value of the ownerId send in the insert/update statements as well as in Filters Views where the filter contains OwnerId or OwnerGUID.
User Impersonation allows Administrators to access and operate as if they were logged in as that User. The ImpersonatedUserId property defines the Id of the user you are trying to impersonate. The impact this has in the system is the value of the ownerId send in the insert/update statements as well as in Filters Views where the filter contains OwnerId or OwnerGUID.
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.
When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.
Specify multiple properties in a semicolon-separated list.
| 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. |
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"
To include all pseudocolumns for all tables use: "*=*"
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the 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)"
}
}
You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.
Refer to User Defined Views for more information.