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. |
| EmailTemplates | Returns multiple email template 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. |
| Groups | Returns multiple group records. The records can be filtered, and sorted according to the respective parameters. |
| 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. |
| 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. |
| WebhookSubscriptions | Fetches all of the customer webhook subscriptions for your application. |
Create, update, and query the available accounts in SalesLoft.
The Sync App uses 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 MyCustomField = 'customValue'
To add an Account, you must specify at least the Domain and Name. The Sync App can perform an insert in two ways.
INSERT INTO Accounts (Domain, Name, Description)
VALUES ('DomainTest.com', 'TestAccount', 'Description of test account' )
You can also use 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
In a similar way to the Insert operation, you can update an item by specifying the field along with 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, and Domain. Additionally, the Salesloft can perform a batch Upsert for multiple records.
UPSERT INTO Accounts (name, id, domain, description, Tags, OwnerId)
VALUES ('AccountN' ,10917448, 'AccountDom.com', 'This is an upsert', 'tag1Upsert,tag2Upsert', 16081 )
To delete an account, you must specify the account Id. For example:
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. |
| CustomFields | String | False |
Custom fields are defined by the user's team. Only fields with values are presented in the API. |
| UserRelationships | String | False |
Filters by accounts matching all given user relationship fields, _is_null or _unmapped can be passed to filter accounts with null or unmapped user relationship values. |
| 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. |
| Positive | Boolean | False |
Indicates if the call is positive (according to current Positive Calls metric configuration). |
| Connected | Boolean | False |
Indicates if the call is connected (according to current Connected Calls metric configuration). |
| 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. |
Returns multiple email template 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 EmailTemplate. |
| LinksAttachments | String | False |
The LinksAttachments of the EmailTemplate. |
| ArchivedAt | Datetime | False |
The ArchivedAt of the EmailTemplate. |
| Body | String | False |
The Body of the EmailTemplate. |
| BodyPreview | String | False |
The BodyPreview of the EmailTemplate. |
| CadenceTemplate | Boolean | False |
The CadenceTemplate of the EmailTemplate. |
| ClickTrackingEnabled | Boolean | False |
The ClickTrackingEnabled of the EmailTemplate. |
| CountsBounces | Integer | False |
The CountsBounces of the EmailTemplate. |
| CountsClicks | Integer | False |
The CountsClicks of the EmailTemplate. |
| CountsReplies | Integer | False |
The CountsReplies of the EmailTemplate. |
| CountsSentEmails | Integer | False |
The CountsSentEmails of the EmailTemplate. |
| CountsViews | Integer | False |
The CountsViews of the EmailTemplate. |
| CreatedAt | Datetime | False |
The CreatedAt of the EmailTemplate. |
| GroupsId | String | False |
The GroupsId of the EmailTemplate. |
| LastUsedAt | Datetime | False |
The LastUsedAt of the EmailTemplate. |
| OpenTrackingEnabled | Boolean | False |
The OpenTrackingEnabled of the EmailTemplate. |
| Shared | Boolean | False |
The Shared of the EmailTemplate. |
| Subject | String | False |
The Subject of the EmailTemplate. |
| Tags | String | False |
The Tags of the EmailTemplate. |
| TeamTemplateId | String | False |
The TeamTemplateId of the EmailTemplate. |
| TemplateOwnerId | Integer | False |
The TemplateOwnerId of the EmailTemplate. |
| Title | String | False |
The Title of the EmailTemplate. |
| UpdatedAt | Datetime | False |
The UpdatedAt of the EmailTemplate. |
| LinkedToTeamTemplate | Boolean | False |
The LinkedToTeamTemplate property of the EmailTemplates table. |
| TagIDs | String | False |
The TagIDs property of the EmailTemplates table. |
| Search | String | False |
The Search property of the EmailTemplates table. |
| FilterByOwner | Boolean | False |
The FilterByOwner property of the EmailTemplates table. |
| IncludeCadenceTemplates | Boolean | False |
The IncludeCadenceTemplates property of the EmailTemplates table. |
| IncludeArchivedTemplates | Boolean | False |
The IncludeArchivedTemplates property of the EmailTemplates table. |
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. |
Returns multiple group records. The records can be filtered, and sorted according to the respective parameters.
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
The Id of the Group. |
| Name | String | False |
The Name of the Group. |
| ParentId | Integer | False |
The ParentId of the Group. |
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. |
| ErrorsList | String | False |
Array of the errors. |
| ImportType | String | False |
Type of 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. |
| PersonId | Integer | False |
The Salesloft Person Id for the recipient. |
| CadenceId | Integer | False |
The Salesloft Cadence Id associated with meeting. |
| StepId | Integer | 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. |
| OwnedByUserId | String | False |
The Id of the meeting Owner. |
| BookedByUserId | String | False |
The Id of the User who booked the meeting. |
| CRM | String | False |
Crm fields mapping from intake form. |
| RescheduleGUID | String | False |
Unique identifier (GUID) for the reschedule meeting link. Use this GUID as a parameter in the API endpoint to retrieve a meeting link. |
| Recurrence | String | False |
List of RRULE for a recurring event, as specified in RFC5545. This field is omitted for single events or instances of recurring events. |
| RecurringInterval | String | False |
Specifies how often a recurring event repeats (Daily, Weekly, Monthly, Yearly). This field is omitted for single events or instances of recurring events. |
| LastOccurenceAt | Datetime | False |
The timestamp of the last occurrence in a series of recurring events. |
| UndoCompletionCount | Integer | False |
The number of times a meeting has been rescheduled after completion. |
| CountTowardsMeetingAttendedMetric | Boolean | False |
Whether the meeting counts towards the Meetings Attended configurable metric. |
| CountTowadsMeetingsBookedMetric | Boolean | False |
Whether the meeting counts towards the Meetings Booked configurable metric. |
| 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 uses 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 MyCustomField = 'customValue'
To insert a Person, you must specify the EmailAddress, FirstName, and LastName need to be specified. You can execute the insert in one of two ways.
INSERT INTO People (EmailAddress, Phone, FirstName, LastName) VALUES ('[email protected]', '123456', 'FirstNameTest', 'LastNameTest')
You can also use 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
In a similar manner to the insert operation, you 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, you must provide an upsert key. The valid options are: ID, CrmId, and EmailAddress. Additionally, the Sync App can execute a batch upsert for multiple records.
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. |
| AccountCRMId | String | False |
Account CRM ID. |
| LocaleUTCOffset | Integer | False |
The locale's timezone offset from UTC in minutes. |
| EUResident | Boolean | False |
Whether this person is marked as a European Union Resident or not. |
| CustomFields | String | False |
Custom fields are defined by the user's team. Only fields with values are presented in the API. |
| SuccessCount | Integer | False |
The person's success count. 1 if person has any active successes, 0 otherwise. |
| Starred | Boolean | False |
Whether this person is starred by the current user. |
| Untouched | Boolean | False |
The person's untouched status. |
| HotLead | Boolean | False |
Whether this person is marked as a hot lead. |
| CadenceIds | String | False |
The list of active cadence ids (comma-separated) person is added to. |
| 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. |
| Active | Boolean | False |
Flag signalizing whether the Person Stage is active. |
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. |
| SignalRegistrationId | Integer | False |
The Associated signal registration Id. |
| 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. |
| Shared | Boolean | False |
Whether the view is public to the team or not. |
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. |
| 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. |
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. |
| Description | String | False |
A description of the task recorded for person at completion time. |
| OpportunityId | Integer | False |
The opportunity id associated with task. |
| ExpiresAfter | Datetime | False |
Datetime of when the the task will expire, ISO-8601 datetime format required. |
| 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. |
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 | ReadOnly | Description |
| Id [KEY] | Integer | True |
The Id of the User. |
| Active | Boolean | False |
The Active property of the User. |
| BCCEmailAddress | String | True |
The BCCEmailAddress property of the User. |
| ClickToCallEnabled | Boolean | True |
The ClickToCallEnabled property of the User. |
| CreatedAt | Datetime | True |
The CreatedAt property of the User. |
| CrmConnected | Boolean | True |
The CrmConnected property of the User. |
| String | True |
The Email property of the User. | |
| EmailClientConfigured | Boolean | True |
The EmailClientConfigured property of the User. |
| EmailClientEmailAddress | String | True |
The EmailClientConfigured property of the User. |
| EmailSignature | String | True |
The EmailSignature property of the User. |
| EmailSignatureClickTrackingDisabled | Boolean | True |
The EmailSignatureClickTrackingDisabled property of the User. |
| EmailSignatureType | String | True |
The EmailSignatureType property of the User. |
| FirstName | String | True |
The FirstName property of the User. |
| FromAddress | String | True |
The FromAddress property of the User. |
| FullEmailAddress | String | True |
The FullEmailAddress property of the User. |
| GroupId | Integer | False |
The GroupId property of the User. |
| Guid | String | True |
The Guid of the User. |
| JobRole | String | True |
The JobRole property of the User. |
| LastName | String | True |
The LastName property of the User. |
| LocalDialEnabled | Boolean | True |
The LocalDialEnabled property of the User. |
| Name | String | True |
The Name of the User. |
| PhoneClientId | Integer | True |
The PhoneClientId property of the User. |
| PhoneNumberAssignmentId | Integer | True |
The PhoneNumberAssignmentId property of the User. |
| RoleId | String | False |
The RoleId property of the User. |
| SendingEmailAddress | String | True |
The SendingEmailAddress property of the User. |
| SlackUsername | String | True |
The SlackUsername property of the User. |
| TeamId | Integer | True |
The TeamId property of the User. |
| TeamAdmin | Boolean | True |
The TeamAdmin property of the User. |
| TimeZone | String | True |
The TimeZone of the User. |
| TwitterHandle | String | True |
The TwitterHandle of the User. |
| UpdatedAt | Datetime | True |
The UpdatedAt date of the User. |
| WorkCountry | String | False |
The user's work country (alpha-2 code) |
| SeatPackage | String | False |
The user's work country (alpha-2 code) |
| ManagedUserGuid | String | False |
The user's work country (alpha-2 code) |
| Search | String | True |
The Search property of the Users table. |
| VisibleOnly | Boolean | True |
The VisibleOnly property of the Users 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. |
| 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. |
| 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. |
| 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, which can be filtered, paged, and sorted according to specified parameters. Team templates are available across the entire team, allowing admins to create content, manage version control, and track performance. All metrics apply to the entire team. Individual template metrics can be accessed through the email_templates API endpoint. |
| Transcriptions | List Conversation Transcriptions. |
| TranscriptionsArtifact | Fetches a Conversation Transcription Artifact. |
| TranscriptionsSentences | Fetches a Conversation Transcription's sentence data. |
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. |
| Active | Boolean | Flag signalizing whether the Account Stage is active. |
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. |
| Active | Boolean | Flag signalizing whether the Person Stage is active. |
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. |
| TaskId | Integer | The TaskId associated with an 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. |
| Tags | String | A list of tags for this activity. |
| 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. |
| LatestActiveDate | Date | Date of when the cadence was last used. |
| Archived | Boolean | Whether this cadence is archived. |
| 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. |
| ExternalIdentifier | String | Cadence External ID. |
| CurrentState | String | The state of the Cadence. Read Only. Valid states are: draft, active, archived, expired, deleted. |
| CreatorId | Integer | The Id of the User that created this cadence. |
| CadencePriorityId | Integer | The Priority Id of the cadence. |
| GroupIds | String | GroupIds (comma-separated) to which this cadence is assigned, if any. |
| CountsCadencePeople | Integer | The number of people that have ever been added to the cadence. |
| CountsPeopleActedOnCount | Integer | The number of people that have been skipped, scheduled, or advanced in a cadence. |
| CountsTargetDailyPeople | Integer | The user defined target for number of people to add to the cadence each day. |
| CountsOpportunitiesCreated | Integer | The number of opportunities created and attributed to the cadence. |
| CountsMettingsBooked | Integer | The number of meetings booked and attributed to the cadence. |
| PendingActionsAssignedTo | String | Filters by whether the Cadence has at least one pending cadence action assigned to any of the provided accounts. |
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. |
| StartedAt | Datetime | Datetime of when the call started. |
| EndedAt | Datetime | Datetime of when the call ended. |
| DialerRecordingUUID | String | The dialer recording uuid resource for the call recording. |
| 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 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. |
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. |
| FirstName | String | Account first name. |
| LastName | String | Account last name. |
| Name | String | Account name. |
| CRMUsername | String | CRM Username. |
Returns multiple email records. The records can be filtered, paged, and sorted according to the respective parameters.
The Salesloft API returns multiple email records. The Subject and Body fields return NULL if the access token does not include the required privileged scopes.
To access the content of the Body field, the email_bodies privileged scope must be granted. To access the Subject field, the email_contents privileged scope is required.
These privileged scopes can be granted when creating the API key or when configuring a custom OAuth application.
| 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. |
| Subject | String | Subject of the email. |
| Body | String | Email Body. |
| ErrorMessage | String | Error message of the email. |
| DraftWithAI | Boolean | Whether this email body was drafted with AI assistance. |
| TaskId | Integer | Task Id that this email was sent from, or null if not sent through a cadence. |
| EmailTemplateId | Integer | Template Id used for this email. |
| AdditionalRecipientsIds | String | The comma-separated list of people ids, other than the (primary) recipient, who received this email via TO and CC. |
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. |
| Scanned | Boolean | Checks if attachment has been scanned. |
| AttachmentContentType | String | Content type of the attachment. |
| AttachmentFingerprint | Integer | Unique attachment Identifier. |
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. |
| UpdatedAt | Datetime | The UpdatedAt of the Email. |
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 | String | 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. |
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. |
| MultitouchEnabled | Boolean | Whether this step is a multitouch cadence step. |
| Name | String | Name of the step. |
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 | Integer | Number of tasks with type: call. |
| TotalEmailTasks | Integer | Number of tasks with type: email. |
| TotalGeneralTasks | Integer | Number of tasks with type: general. |
| TotalIntegrationTasks | Integer | Number of tasks with type: integration. |
| TotalOtherTasks | Integer | Number of tasks with type: other. |
| TotalTasks | Integer | Number of tasks with type: total. |
| Id | Integer | IDs of tasks to fetch. |
| UserId | Integer | Filters tasks by the user to which they are assigned. |
| PersonId | Integer | Filters tasks by the person to which they are associated. |
| AccountId | Integer | Filters tasks by the account to which they are associated. |
| CurrentState | String | Filters tasks by the account to which they are associated. |
| TimeIntervalFilter | 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 | 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 | String | Filters tasks by idempotency key. |
| Locale | String | Filters tasks by locale of the person to which they are associated. |
| Source | 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. |
| 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. |
| PlanFeatures | String | Add on features for this team. |
| Deactivated | Booelan | Indicates if the team has been deactivated. |
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, which can be filtered, paged, and sorted according to specified parameters. Team templates are available across the entire team, allowing admins to create content, manage version control, and track performance. All metrics apply to the entire team. Individual template metrics can be accessed through 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. |
| UpdatedAt | Datetime | The UpdatedAt of the Transcription. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Salesloft.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Salesloft, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| CadenceExport | New cadences can be created or steps can be imported onto existing cadences which do not have steps. |
| CadenceImport | New cadences can be created or steps can be imported onto existing cadences which do not have steps. |
| CreateActivity | Creates an activity. The creation of an activity marks the associated action as completed. Currently, only certain action types can have an activity explicitly created for them. |
| CreateConversationCall | Creates an activity. An activity will mark the associated action as completed. Currently, only certain action types can have an activity explicitly created for them. |
| CreateExternalEmail | Creates an external email object. Note: The external emails create endpoint requires special scopes that have to be enabled by the Salesloft engineering team. To enable the Scopes, please contact the Salesloft support center. |
| CreateOngoingAction | Creates an activity. An activity will mark the associated action as completed. Currently, only certain action types can have an activity explicitly created for them. |
| GetCallerIds | 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. |
| GetRecordingSettings | 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. |
New cadences can be created or steps can be imported onto existing cadences which do not have steps.
| Name | Type | Required | Description |
| Id | String | True | Id of a cadence. |
| Name | Type | Description |
| CadenceContent | String | The content of the cadence. |
New cadences can be created or steps can be imported onto existing cadences which do not have steps.
| Name | Type | Required | Description |
| Settings | String | False | Settings for a cadence. |
| SharingSettings | String | False | The shared settings for a cadence. |
| CadenceContent | String | False | Import data for cadence. |
| Name | Type | Description |
| CadenceId | String | Datetime of when the Activity was last updated. |
Creates an activity. The creation of an activity marks the associated action as completed. Currently, only certain action types can have an activity explicitly created for them.
| Name | Type | Required | Description |
| ActionId | Integer | False | The action that is being completed. An action with the specified Id must exist. The action must be of the type: 'integration'. |
| TaskId | Integer | False | The task that is being completed. A task with the specified Id must exist. The task must be of the type: 'integration'. |
| Name | Type | Description |
| UpdatedAt | Datetime | The time at which the Activity was last updated. |
Creates an activity. An activity will mark the associated action as completed. Currently, only certain action types can have an activity explicitly created for them.
| Name | Type | Required | Description |
| To | String | True | Phone number that was called. |
| From | String | True | Phone number that call was made from. |
| Duration | Integer | True | Duration of call in seconds. |
| Recording | String | True | Object containing recording info including the audio file (.mp3, .wav, .ogg, .m4a). |
| CallCreatedAt | String | False | Timestamp for when the call started. If not provided, will default to the time the request was received. |
| Direction | String | False | Call directions. |
| UserGuid | String | True | Guid of the Salesloft User to assign the call to. If not provided, will default to the user within the authentication token. |
| Name | Type | Description |
| To | String | Phone number that was called. |
| From | String | Phone number that call was made from. |
| Duration | Integer | Duration of call in seconds. |
| Recording | String | Object containing recording info including the audio file (.mp3, .wav, .ogg, .m4a). |
| CallCreatedAt | String | Timestamp for when the call started. If not provided, will default to the time the request was received. |
| UserGuid | String | Guid of the Salesloft User to assign the call to. If not provided, will default to the user within the authentication token. |
| Direction | String | Call directions. |
Creates an external email object. Note: The external emails create endpoint requires special scopes that have to be enabled by the Salesloft engineering team. To enable the Scopes, please contact the Salesloft support center.
| Name | Type | Required | Description |
| Mailbox | String | True | Email address of mailbox email was sent to. |
| Raw | String | True | Base64 encoded MIME email content. |
| Name | Type | Description |
| MessageId | String | Message id present in the External Email header. |
Creates an activity. An activity will mark the associated action as completed. Currently, only certain action types can have an activity explicitly created for them.
| Name | Type | Required | Description |
| ActionId | Integer | True | Action that is being marked ongoing. This will validate that the action is still valid before modifying it. Ongoing actions can not be marked ongoing. |
| Name | Type | Description |
| Id | String | ID of Action. |
| Due | Boolean | Whether this step is due. |
| CreatedAt | Datetime | Datetime of when the Action was created. |
| UpdatedAt | Datetime | Datetime of when the Action was last updated. |
| Type | String | The type of this action. Valid types are: email, phone, other. New types may be added in the future. |
| Status | String | The current state of the person on the cadence. Possible values are: in_progress, pending_activity. |
| DueOn | Datetime | When action is due. |
| MultitouchGroupId | Integer | ID of the multitouch group. |
| ActionDetailsId | String | The type specific action details. |
| UserId | String | User assigned to action. |
| PersonId | String | The subject of an action. |
| CadenceId | String | The cadence of an action. |
| StepId | String | The step of an action. |
Creates a schema file for the specified table or view.
Creates a local schema file (.rsd) from an existing table or view in the data model.
The schema file is created in the directory set in the Location connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.
The Sync App checks the Location to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location that does not match an existing table or view, a new table or view entry is added to the data model of the Sync App.
| Name | Type | Required | Description |
| TableName | String | True | The name of the table or view. |
| FileName | String | False | The full file path and name of the schema to generate. Ex : 'C:\\Users\\User\\Desktop\\SalesLoft\\People.rsd' |
| Name | Type | Description |
| Result | String | Returns Success or Failure. |
| FileData | String | File data that will be outputted encoded in Base64 if the FileName and FileStream inputs are not set. |
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 | Required | Description |
| PhoneNumber | String | True | The PhoneNumber property of the CallerIDs table. |
| 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. |
Gets an authentication token from SalesLoft.
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
The allowed values are APP, WEB. The default value is APP. |
| Scope | String | False | A comma-separated list of permissions to request from the user. Please check the SalesLoft API for a list of available permissions. |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the SalesLoft app settings. Only needed when the Authmode parameter is Web. |
| Verifier | String | False | The verifier returned from SalesLoft after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
| State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the SalesLoft authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with SalesLoft. |
| OAuthRefreshToken | String | The OAuth refresh token. This is the same as the access token in the case of SalesLoft. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the SalesLoft app settings. |
| Scope | String | False | A comma-separated list of scopes to request from the user. Please check the SalesLoft API documentation for a list of available permissions. |
| State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the SalesLoft authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
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 | Required | Description |
| Id | String | True | The id of the RecordingSettings. E.164 Phone Number. |
| Name | Type | Description |
| RecordingDefault | Boolean | Whether this phone number should record by default. |
| PartiesToRecord | String | How many parties to record. Can be one of: none, both, one |
Refreshes the OAuth access token used for authentication with SalesLoft.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | Set this to the token value that expired. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from SalesLoft. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | This is the same as the access token. |
| ExpiresIn | String | The remaining lifetime on the access token. |
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 (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
| 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 | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server 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 | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies 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 number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines 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 (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.
When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.
When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.
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 you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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 |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
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 | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server 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 | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies 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. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
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 (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (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.
Supported authentication types :
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.
Provides 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 username of a user registered with the proxy server. |
| DIGEST | The username 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. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of 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.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies 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. |
Specifies 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: 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.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
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 number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines 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 number of rows returned for queries that do not include either aggregation or GROUP BY.
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use 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.
| Property | Description |
| 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=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
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 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.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows 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.
Note: 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 that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews 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 use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.