Getting Started

This page provides a guide to Establishing a Connection to Outreach in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Outreach

Establishing a Connection shows how to authenticate to Outreach and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Outreach through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Establishing a Connection

Connect to Outreach by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Outreach

Outreach supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to Outreach from three common authentication flows:

Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping. Authenticated via either embedded OAuth or custom OAuth.
Web: access to data via a shared website. Authenticated via custom OAuth only.
Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard. Authenticated via embedded OAuth or custom OAuth.

For information about how to obtain custom OAuth information, and why you might want to create a custom connection 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 Outreach, see Connection.

When the access token expires, the Cloud refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the Cloud automatically refresh the OAuth access token, do the following:

The first time you connect to data, set the following connection parameters:
- InitiateOAuth: REFRESH.
- OAuthClientId: The client Id in your application settings.
- OAuthClientSecret: The client secret in your application settings.
- OAuthAccessToken: The access token returned by GetOAuthAccessToken.
- OAuthSettingsLocation: The path where you want the Cloud to save the OAuth values, which persist across connections.
On subsequent data connections, set the following:
- InitiateOAuth
- OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAUth access token is the OAuth refresh token.

To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
Set the following connection properties:
- OAuthClientId: The Client Id in your application settings.
- OAuthClientSecret: The Client Secret in your application settings.
Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to Outreach via a desktop application or a headless machine. If you want to use the embedded OAuth application, all you need to do to connect is to:

set AuthScheme to OAuth,
get and set the OAuthAccessToken, and
set the necessary configuration parameters.

(For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Connecting to Outreach".)

However, if you need to connect to Outreach via the Web, you will have to create a custom OAuth connection. In fact, since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway. Custom OAuth applications are useful if you want to:

control branding of the authentication dialog;
control the redirect URI that the application redirects the user to after the user authenticates; or
customize the permissions that you are requesting from the user.

Procedure

To obtain the OAuth client credentials you need to make a custom OAuth connection, including OAuthClientId and OAuthClientSecret, contact Outreach directly via [email protected].

After you obtain this information, use it to configure the connection variables to connect and authenticate to Outreach, as described in "Connecting to Outreach".

Data Model

Overview

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

Key Features

The Cloud models Outreach entities as relational views, allowing you to write SQL to query Outreach data.
Stored procedures allow you to execute operations to Outreach.
Live connectivity to these objects means any changes to your Outreach account are immediately reflected when using the Cloud.

Views

Views describes the available views. Views are statically defined to model Outreach entities such as Accounts, Prospects, and Calls.

Stored Procedures

Stored Procedures are function-like interfaces to Outreach.

Stored procedures allow you to execute operations to Outreach, including downloading documents and moving envelopes.

Views

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.

CData Cloud - Outreach Views


Name	Description
Accounts	Get Details of accounts.
CallDispositions	A ready-made collection of call dispositions that help categorize your call logs.
CallPurposes	Get details of ready-made collection of call dispositions that help categorize your call logs.
Calls	Get details of an inbound or outbound call made with a prospect.
ComplianceRequests	Get details of compliance requests.
ContentCategories	Get details of content categories.
ContentCategoryMemberships	Get details of a record that maps content to a content category.
ContentCategoryOwnerships	A record that maps content to a content category.
Duties	An Outreach-suggested role or job duty played by a user in their organization.
EmailAddress	Get details of prospect email addresses.
Events	Get details of application events, capturing details around the initiator, recipient.
Favorites	Get details of a record favorited by a particular user.
MailAliases	Alternative email name for a mailbox.
Mailbox	Get details of email mailboxes.
Mailings	Get details of mailings.
Opportunities	Get details of opportunity for a sale or pending deal.
OpportunityProspectRoles	Get details of prospect roles and associated with an opportunity.
OpportunityStages	The stage an opportunity is in.
Personas	A descriptor of a person used for categorizing prospects.
PhoneNumbers	Get details of prospect phone numbers.
Profiles	Controls what you can see and do within Outreach.
Prospects	Get Details of Prospects.
Recipients	Record for a recipient for some communication, such as email.
Roles	Get details of where you fall within your organizations structure.
Rulesets	A reusable set of behaviors to be applied to sequences.
Sequences	Get details of sequences.
SequenceStates	Get details of sequence states.
SequenceSteps	Get details of sequence steps.
SequenceTemplates	An object used to track which templates are in use by which sequence steps.
Snippets	Piece of an email to be reused in multiple messages.
Stages	The point in the process used for categorizing prospects.
TaskPriorities	Descriptor of importance used for categorizing tasks.
Tasks	An item that requires action to complete.
Teams	Get details of a group of users.
Templates	Get details of reusable templates for building emails.
Users	Get deatils of The individual that uses the application.
UsersDuties	Get details of the individual that uses the application.

Accounts

Get Details of accounts.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
BuyerIntentScore supports the '=,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
CustomId supports the '=,>=,<=,>,<' operators.
Domain supports the '=,IN' operators.
Name supports the '=,IN' operators.
Nammed supports the '=,IN' operators.
SharingTeamId supports the '=,IN' operators.
TouchedAt supports the '=,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Accounts WHERE Id = 1

SELECT * FROM Accounts WHERE Id IN (1, 2)

SELECT * FROM Accounts WHERE Id >= 1

SELECT * FROM Accounts WHERE Id <= 1

SELECT * FROM Accounts WHERE Id > 1

SELECT * FROM Accounts WHERE Id < 2

SELECT * FROM Accounts WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM accounts WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CustomId = 1

SELECT * FROM Accounts WHERE BuyerIntentScore = 1

SELECT * FROM Accounts WHERE SharingTeamId = 1

Columns


Name	Type	Description
Id [KEY]	Integer	Id of Accounts.
BuyerIntentScore	Double	A custom score given to measure the quality of the account.
CompanyType	String	A description of the company type.
CreatedAt	Datetime	The date and time the account was created.
CustomId	String	A custom ID for the account often referencing an ID in an external system.
Description	String	A custom description of the account.
Domain	String	The company website domain.
ExternalSource	String	The source of the resource creation.
Followers	String	The number of followers the company has listed on social media.
FoundedAt	Datetime	The founding date of the company.
Industry	String	A description of the company industry.
LinkedInEmployees	String	The number of employees listed on the company LinkedIn URL.
LinkedInUrl	String	The company LinkedIn URL.
Locality	String	The company primary geographic region.
Name	String	The name of the company.
Named	Boolean	A boolean value determining whether this is a named account or not Only named accounts will show up on the collection index.
NaturalName	String	The natural name of the company.
NumberOfEmployees	String	The number of employees working at the company.
SharingTeamId	String	The ID of the sharing team associated with this object Access is currently in beta.
Tags	String	A list of tag values associated with the account.
TouchedAt	Datetime	The date and time the account was last touched.
TrashedAt	String	The date and time the account was last updated.
UpdatedAt	Datetime	The date and time the account was last touched at.
WebsiteUrl	String	The company website URL.
LinksSelf	String	Link Self.
Creatorid	Integer	Creator Id.
CreatorType	String	Creator Type.
OwnerId	Integer	owner Id.
OwnerType	String	Owner Type.
ProspectsLinks	String	Prospects Links.
TasksLinks	String	Tasks Links.
UpdaterId	Integer	Updater Id.
UpdaterType	String	Updater Type.
Type	String	Type.

CallDispositions

A ready-made collection of call dispositions that help categorize your call logs.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
OrderValue supports the '=,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.
Name supports the '=,IN' operators.

For example, the following query is processed server side:

SELECT * FROM CallDispositions WHERE Id = 1

SELECT * FROM CallDispositions WHERE Id IN (1, 2)

SELECT * FROM CallDispositions WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE Name = 'Answered - Meeting Set'

SELECT * FROM CallDispositions WHERE Name IN ('test', 'ram')

SELECT * FROM CallDispositions WHERE OrderValue = 1

Columns


Name	Type	Description
Id [KEY]	Integer	Id.
CreatedAt	Datetime	The date and time the call disposition was created.
LinksSelf	String	Links self.
Name	String	The disposition's name.
OrderValue	Integer	The disposition's display OrderValue within the collection.
Outcome	String	The disposition's call outcome.
UpdatedAt	Datetime	The date and time the call disposition was last updated.
CallsLinks	String	Calls links.
CreatorId	Integer	Creator Id.
Type	String	Type of disposition.

CallPurposes

Get details of ready-made collection of call dispositions that help categorize your call logs.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
OrderValue supports the '=,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.
Name supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM CallPurposes WHERE Id = 1

SELECT * FROM CallPurposes WHERE Id IN (1, 2)

SELECT * FROM CallPurposes WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE Name = 'Answered - Meeting Set'

SELECT * FROM CallPurposes WHERE Name IN ('test', 'ram')

SELECT * FROM CallPurposes WHERE OrderValue = 1

Columns


Name	Type	Description
Id [KEY]	Integer	Id.
CreatedAt	Datetime	The date and time the call disposition was created.
LinksSelf	String	Links self.
Name	String	The purpose's name.
OrderValue	Integer	The purpose's display OrderValue within the collection.
UpdatedAt	Datetime	The date and time the call disposition was last updated.
CallsLinks	String	Calls Links.
CreatorId	Integer	Creator Id.
Type	String	Type of disposition.

Calls

Get details of an inbound or outbound call made with a prospect.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
From supports the '=,IN' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Outcome supports the '=,IN' operators.
State supports the '=,IN' operators.
To supports the '=,IN' operators.
UserCallType supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Calls WHERE Id = 1

SELECT * FROM Calls WHERE Id IN (1, 2)

SELECT * FROM Calls WHERE Id >= 1

SELECT * FROM Calls WHERE Id <= 1

SELECT * FROM Calls WHERE Id > 1

SELECT * FROM Calls WHERE Id < 2

SELECT * FROM Calls WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE UserCallType = 'bridge'

SELECT * FROM Calls WHERE UserCallType IN('bridge', 'test')

Columns


Name	Type	Description
Id [KEY]	Integer	Id of call.
AnsweredAt	Datetime	The date and time the call was answered.
CompletedAt	Datetime	The date and time the call was completed.
CreatedAt	Datetime	The date and time the call was created.
DialedAt	Datetime	The date and time the call was dialed.
Direction	String	The call direction from the user's point of view.
ExternalVendor	String	The voice provider of the call.
From	String	The phone number used to place the call.
Note	String	A custom note associated with this call.
Outcome	String	The calls outcome. Possible values are 'Answered', 'Not Answered', etc.
RecordingDeletionReason	String	Recording Deletion Reason.
RecordingUrl	String	The URL of the calls audio recording.
ReturnedAt	Datetime	The date and time the call was returned.
SequenceAction	String	The action to take on the associated sequence.
ShouldRecordCall	Boolean	Indicated whether or not the call is recorded.
State	String	The calls current state.
StateChangedAt	Datetime	The date and time the calls state last changed.
Tags	String	A list of tag values associated with the call.
To	String	The phone number that the call was placed to.
Uid	String	The Outreach voice trace Id.
UpdatedAt	Datetime	The date and time the call was last updated.
UserCallType	String	The type of call placed within the Outreach client. Possible values are bridge, voip, etc.
VendorCallId	String	The call-id as recorded by the voice provider.
VoicemailRecordingUrl	String	The URL of the calls voicemail audio recording.
LinksSelf	String	Link self.
BatchesLinks	String	Batches Links.
CallDispositionId	Integer	The associated call disposition Id.
CallDispositionType	String	The associated Call disposition type.
CallPurposeId	Integer	The associated call purpose Id.
CallPurposeType	String	The associated call purpose type.
OpportunityId	Integer	The associated opportunity Id.
PhoneNumberId	Integer	The associated phone number's Id.
ProspectId	Integer	The associated prospect Id.
SequenceId	Integer	The associated sequence Id.
SequenceStateId	Integer	The associated sequenceStates Id.
SequenceStepId	Integer	The associated sequence Step Id.
TaskId	Integer	The associated task's Id.
UserId	Integer	The associated user's Id.
Type	String	Type.

ComplianceRequests

Get details of compliance requests.

Select

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

Id supports the '=,IN' operators.
State supports the '=,IN' operators.
UuId supports the '=,IN' operators.

For example, the following query is processed server side:

SELECT * FROM ComplianceRequests WHERE Id = 1

SELECT * FROM ComplianceRequests WHERE Id IN (1, 2)

SELECT * FROM ComplianceRequests WHERE State = 'test'

SELECT * FROM ComplianceRequests WHERE uuid = '12345'

SELECT * FROM ComplianceRequests WHERE uuid IN (1, 2)

Columns


Name	Type	Description
Id [KEY]	Integer	Id of compliance request.
BatchComplianceRequestUuid	String	The UUID of the batch the compliance request belongs to.
CreatedAt	Datetime	The date and time the compliance request was created.
ObjectType	String	The type of record to process.
RequestObjectId	String	The identifier for the record processed for prospects. This is the prospect Id for recipients. This is an e-mail address.
RequesterId	Integer	The ID of the Outreach user who submitted the compliance request.
RequestType	String	The type of compliance request.
State	String	The current state of the compliance request.
UpdatedAt	Datetime	The date and time at which the compliance request was last updated.
UuId	String	The UUID of the compliance request.

ContentCategories

Get details of content categories.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Name supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM ContentCategories WHERE Id = 1

SELECT * FROM ContentCategories WHERE Id IN (1, 2)

SELECT * FROM ContentCategories WHERE Id >= 1

SELECT * FROM ContentCategories WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt >= '2022-01-25 01:02:02.0 ' AND UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt > '2022-02-25 01:02:02.0'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of Content Category.
AllowSequences	Boolean	Whether or not this category be used to group sequences.
AllowSnippets	Boolean	Whether or not this category be used to group snippets.
AllowTemplates	Boolean	Whether or not this category be used to group templates.
Color	String	Color of the content category to be used as a background.
CreatedAt	Datetime	The date and time the content category was created.
Name	String	The name of the content category.
UpdatedAt	Datetime	The date and time the content category was last updated.
LinksSelf	String	Link self.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator type.
Type	String	Types.

ContentCategoryMemberships

Get details of a record that maps content to a content category.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM ContentCategoryMemberships WHERE Id = 1

SELECT * FROM ContentCategoryMemberships WHERE Id IN (1, 2)

SELECT * FROM ContentCategoryMemberships WHERE Id >= 1

SELECT * FROM ContentCategoryMemberships WHERE Id < 2

SELECT * FROM ContentCategoryMemberships WHERE Id <= 2

SELECT * FROM ContentCategoryMemberships WHERE Id >= 1 AND Id <= 10

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-27 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt >= '2022-01-25 01:02:02.0 ' AND UpdatedAt <= '2022-02-27 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt > '2022-02-25 01:02:02.0'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of content category memberships.
CreatedAt	Datetime	The date and time the content category membership was created.
UpdatedAt	Datetime	The date and time the content category membership was last updated.
ContentCategoryId	Integer	The content category Id.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator type.
OwnerId	Integer	owner Id.
OwnerType	String	Owner type.
Type	String	Types.

ContentCategoryOwnerships

A record that maps content to a content category.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM ContentCategoryOwnerships WHERE Id = 1

SELECT * FROM ContentCategoryOwnerships WHERE Id IN (1, 2)

SELECT * FROM ContentCategoryOwnerships WHERE Id >= 1

SELECT * FROM ContentCategoryOwnerships WHERE Id < 2

SELECT * FROM ContentCategoryOwnerships WHERE Id <= 2

SELECT * FROM ContentCategoryOwnerships WHERE Id >= 1 AND Id <= 10

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-27 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt >= '2022-01-25 01:02:02.0 ' AND UpdatedAt <= '2022-02-27 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt > '2022-02-25 01:02:02.0'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of content category ownerships.
CreatedAt	Datetime	The date and time the content category ownership was created.
UpdatedAt	Datetime	The date and time the content category ownership was last updated.
ContentCategoryId	Integer	The content category Id.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator type.
Type	String	Type.

Duties

An Outreach-suggested role or job duty played by a user in their organization.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Duties WHERE Id = 1

SELECT * FROM Duties WHERE Id IN (1, 2)

SELECT * FROM Duties WHERE Id >= 1

SELECT * FROM Duties WHERE Id <= 4

SELECT * FROM Duties WHERE Id > 1

SELECT * FROM Duties WHERE Id < 4

Columns


Name	Type	Description
Id [KEY]	Integer	Id of duty.
DutyType	String	The polymorphic type of the duty.
SymbolicName	String	The string constant used to refer to this duty which can be internationalized on the client.
Type	String	Type.

EmailAddress

Get details of prospect email addresses.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
Email supports the '=,IN' operators.
EmailType supports the '=,IN' operators.
Status supports the '=,IN' operators.
OrderValue supports the '=,>=,<=,>,<' operators.
StatusChangedAt supports the '=,>=,<=,>,<' operators.
UnsubscribedAt supports the '=,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM EmailAddress WHERE Id = 1

SELECT * FROM EmailAddress WHERE Id IN (1, 2)

SELECT * FROM EmailAddress WHERE Id >= 1

SELECT * FROM EmailAddress WHERE Id <= 1

SELECT * FROM EmailAddress WHERE Id > 1

SELECT * FROM EmailAddress WHERE Id < 2

SELECT * FROM EmailAddress WHERE StatusChangedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt >= '2022-01-25 01:02:02.0 ' AND StatusChangedAt <= '2022-02-27 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt = '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt < '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt > '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE UnsubscribedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE Email = '[email protected]'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of Email Address.
BouncedAt	Datetime	The date and time the email was bounced.
CreatedAt	Datetime	The date and time the email address was created.
Email	String	The raw email address value.
EmailType	String	Type of email address.
OrderValue	Integer	Ordered position in list of emails.
Status	String	The status of the email.
StatusChangedAt	Datetime	Time the status was updated.
UnsubscribedAt	Datetime	Time a mailing was unsubscribed using this address.
UpdatedAt	Datetime	The date and time the email address was last updated.
LinksSelf	String	Link self.
ProspectId	Integer	Prospect's Id.
ProspectType	String	Relationship type.
Type	String	Type.

Events

Get details of application events, capturing details around the initiator, recipient.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
Name supports the '=,IN' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
EventAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Events WHERE Id = 1

SELECT * FROM Events WHERE Id IN (1, 2)

SELECT * FROM Events WHERE Id >= 1

SELECT * FROM Events WHERE Id <= 1

SELECT * FROM Events WHERE Id > 1

SELECT * FROM Events WHERE Id < 2

SELECT * FROM Events WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE EventAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE Name IN ('task_updated', 'task_owner_changed')

Columns


Name	Type	Description
Id [KEY]	Integer	Id of Email Address.
Body	String	The event body.
CreatedAt	Datetime	The date and time the event was created.
EventAt	Datetime	The date and time the event occurred.
ExternalUrl	String	The external URL associated with this event.
Name	String	The name of the event that took place.
Payload	String	The transmitted data for the event.
RequestCity	String	The city where the request that created the event was made.
RequestDevice	String	The type of device on which the request that created the event was made.
RequestHost	String	Name of the host from which the request was made.
RequestProxied	Boolean	A boolean value indicating whether or not the request was proxied.
RequestRegion	String	Name of the region from which the request was made.
LinksSelf	String	Link self.
MailingId	Integer	Mailing Id.
ProspectId	Integer	Prospect's Id.
ProspectType	String	Prospect's type.
UserId	Integer	User's Id.
Type	String	Type.

Favorites

Get details of a record favorited by a particular user.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
TargetType supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Favorites WHERE Id = 1

SELECT * FROM Favorites WHERE Id IN (1, 2)

SELECT * FROM Favorites WHERE Id >= 1

SELECT * FROM Favorites WHERE Id <= 1

SELECT * FROM Favorites WHERE Id > 1

SELECT * FROM Favorites WHERE Id < 2

SELECT * FROM Favorites WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE TargetType = 'Prospect'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of favorites.
CreatedAt	Datetime	The date and time the favorite was created.
TargetType	String	The type of record that was favorited.
UpdatedAt	Datetime	The date and time the favorite was last updated.
LinksSelf	String	Links self.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator type.
UserId	Integer	User's Id.
UserType	String	User's type.
Type	String	Type.

MailAliases

Alternative email name for a mailbox.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM MailAliases WHERE Id = 1

SELECT * FROM MailAliases WHERE Id IN (1, 2)

SELECT * FROM MailAliases WHERE Id >= 1

SELECT * FROM MailAliases WHERE Id <= 1

SELECT * FROM MailAliases WHERE Id > 1

SELECT * FROM MailAliases WHERE Id < 2

SELECT * FROM MailAliases WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of mail alias.
CanSend	Boolean	Whether or not this alias can send email.
CreatedAt	Datetime	The date the alias was created.
Email	String	The email alias.
UpdatedAt	Datetime	The date the alias was last updated.
UserId	Integer	User's Id.
Type	String	Type.

Mailbox

Get details of email mailboxes.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Email supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.
UserId supports the '=,IN,>=,<=,>,<' operator.

For example, the following query is processed server side:

SELECT * FROM Mailbox WHERE Id = 1

SELECT * FROM Mailbox WHERE Id IN (1, 2)

SELECT * FROM Mailbox WHERE Id >= 1

SELECT * FROM Mailbox WHERE Id <= 1

SELECT * FROM Mailbox WHERE Id > 1

SELECT * FROM Mailbox WHERE Id < 2

SELECT * FROM Mailbox WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE UserId = 1

Columns


Name	Type	Description
Id [KEY]	Integer	Id of mailbox.
AuthId	Integer	The Auth Id associated with the mailbox.
CreatedAt	Datetime	The date and time the mailbox was created.
Editable	Boolean	A boolean value to indicate if the user has the permission to edit mailbox fields.
Email	String	The email address of the mailbox.
EmailProvider	String	The mail service provider.
EmailSignature	String	The default signature in HTML to be appended to sent email messages.
EwsEndpoint	String	The url of the Exchange Web Service.
EwsSslVerifyMode	Integer	The SSL verify mode represented as an integer the EWS connection will used.
ExchangeVersion	String	The version of Exchange.
ImapHost	String	The address of the IMAP host used for syncing.
ImapPort	Integer	The port number the IMAP server is using.
ImapSsl	Boolean	A boolean value indicating whether or not the IMAP connection will use SSL.
MaxEmailsPerDay	Integer	The maximum number of in and out emails per day.
MaxMailingsPerDay	Integer	The maximum number of emails the application can send in a day from this mailbox.
MaxMailingsPerWeek	Integer	The maximum number of emails the application can send within a week from this mailbox.
OptOutMessage	String	The message displayed on the unsubscribe confirmation page seen after clicking the unsubscribe link in the email.
OptOutSignature	String	The message below the signature in HTML.
ProspectEmailExclusions	String	A list of email address patterns to be excluded from syncing.
ProviderId	Integer	The Id of the provider associated with this calendar.
ProviderType	String	Email provider type.
SendDisabled	Boolean	A boolean value indicating whether or not sending is disabled from this mailbox.
SendErroredAt	Datetime	The date and time the most recent send error occurred.
SendMaxRetries	Integer	The maximum number of times to auto-retry a delivery when it fails.
SendMethod	String	The method used for sending email.
SendPeriod	Integer	The amount of time in seconds that the number of sendThreshold emails can be sent.
SendPermanentErrorAt	Datetime	The date and time the most recent send error occurred.
SendRequiresSync	Boolean	A boolean value indicating whether or not the mailbox is required to be recently synced before sending.
SendSuccessAt	Datetime	The date and time the most recent successful email send occurred.
SendThreshold	Integer	The maximum number of email sends per the sendPeriod amount of time.
SmtpHost	String	The address of the SMTP host used for sending.
SmtpPort	Integer	The port number the SMTP server is using.
SmtpSsl	Boolean	A boolean value indicating whether or not the SMTP connection will use SSL.
SmtpUsername	String	The username for the SMTP account.
SyncActiveFrequency	Integer	The amount of time in seconds between syncing when the user is actively using the application.
SyncDisabled	Boolean	A boolean value indicating whether or not syncing is disabled from this mailbox.
SyncErroredAt	Datetime	The date and time the most recent sync error occurred.
SyncFinishedAt	Datetime	The date and time the most recent sync finished.
SyncMethod	String	The method used for syncing email.
SyncOutreachFolder	Boolean	A boolean value indicating whether or not the folder for syncing is named Outreach instead of Inbox.
SyncPassiveFrequency	Integer	The amount of time in seconds between syncing when the user is not actively using the application.
SyncSuccessAt	Datetime	The date and time the most recent successful email sync occurred.
UpdatedAt	Datetime	The date and time the mailbox was last updated.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator type.
ownerId	Integer	Owner Id.
OwnerType	String	Owner type.
UserId	Integer	The Id of the user associated with this mailbox.
Username	String	The username of the email account.
Type	String	Type.

Mailings

Get details of mailings.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
BouncedAt supports the '=,>=,<=,>,<' operators.
ClickedAt supports the '=,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
DeliveredAt supports the '=,>=,<=,>,<' operators.
MailingType supports the '=,IN' operators.
MessageId supports the '=,IN' operators.
NotifyThreadScheduledAt supports the '=,>=,<=,>,<' operators.
NotifyThreadStatus supports the '=' operator.
OpenedAt supports the '=,>=,<=,>,<' operators.
RetryAt supports the '=,>=,<=,>,<' operators.
RepliedAt supports the '=,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.
ScheduledAt supports the '=,>=,<=,>,<' operators.
State supports the '=,IN' operator.
StateChangedAt supports the '=,>=,<=,>,<' operators.
UnsubscribedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Mailings WHERE Id = 1

SELECT * FROM Mailings WHERE Id IN (1, 2)

SELECT * FROM Mailings WHERE Id >= 1

SELECT * FROM Mailings WHERE Id <= 1

SELECT * FROM Mailings WHERE Id > 1

SELECT * FROM Mailings WHERE Id < 2

SELECT * FROM Mailings WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of mailing.
BodyHtml	String	The mailing custom email body represented in HTML.
BodyText	String	The plain-text representation of the bodyHTML field.
BouncedAt	Datetime	The date and time the email was bounced.
ClickCount	Integer	The total number of times links within the email were clicked.
ClickedAt	Datetime	The most recent date and time a link was clicked.
CreatedAt	Datetime	The date and time the mailing was created.
DeliveredAt	Datetime	The date and time the email was delivered.
ErrorBacktrace	String	Technical details explaining the mailing error.
ErrorReason	String	A summary explaining the mailing error.
FollowUpTaskScheduledAt	Datetime	The date and time of when a follow-up task should be due for this mailing.
FollowUpTaskType	String	The type of follow-up task to create.
MailboxAddress	String	The email address the mailing was sent from.
MailingType	String	A description of the type of the emailing.
MarkedAsSpamAt	Datetime	The date and time the email was marked as spam.
MessageId	String	The MIME content MessageId of the delivered message.
NotifyThreadCondition	String	The condition of when to bump this mailing to the top of the user inbox.
NotifyThreadScheduledAt	Datetime	The date and time of when this mailing should be bumped to the top of the user inbox.
NotifyThreadStatus	String	The status of the bump. Possible values are 'pending', 'sent', 'skipped', etc.
OpenCount	Integer	The total number of times the email was opened.
OpenedAt	Datetime	The most recent date and time the email was opened.
OverrideSafetySettings	Boolean	A boolean value indicating whether or not users can override submission if template variables have not all been replaced.
References	String	A list of references for the mailing taken from the email header.
RepliedAt	Datetime	The date and time the email was replied to.
RetryAt	Datetime	The date and time the email will retry to send.
RetryCount	Integer	The number of times the email has been retried to send.
RetryInterval	Integer	The amount of time in seconds between retry attempts.
ScheduledAt	Datetime	The date and time the email is scheduled to send.
State	String	The current state of the mailing. Possible values are 'bounced', 'delivered', 'delivering', 'drafted', 'failed', 'opened', 'placeholder', 'queued', 'replied', 'scheduled', etc.
StateChangedAt	Datetime	The date and time the state last changed.
Subject	String	The subject line of the email.
TrackLinks	Boolean	A boolean value indicating whether or not the mailing is tracking link clicks.
TrackOpens	Boolean	A boolean value indicating whether or not the mailing is tracking email opens.
UnsubscribedAt	Datetime	The date and time the recipient unsubscribed from the mailing sequence.
UpdatedAt	Datetime	The date and time the mailing was last updated.
LinksSelf	String	Links self.
MailboxId	Integer	Id of mailbox.
MailboxType	String	Mailbox type.
OpportunityId	Integer	Opportunity's Id.
ProspectId	Integer	Prospect's Id.
ProspectType	String	Prospect's type.
SequenceId	Integer	Sequence Id.
SequenceStateId	Integer	SequenceState Id.
SequenceStepId	Integer	SequenceStep Id.
TaskId	Integer	Task's Id.
Type	String	Type.

Opportunities

Get details of opportunity for a sale or pending deal.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
ExternalCreatedAt supports the '=,>=,<=,>,<' operators.
MapLink supports the '=,IN' operators.
MapStatus supports the '=,IN' operators.
Name supports the '=,IN' operators.
Probability supports the '=,IN,>=,<=,>,<' operators.
SharingTeamId supports the '=,IN' operators.
TouchedAt supports the '=,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Opportunities WHERE Id = 1

SELECT * FROM Opportunities WHERE Id IN (1, 2)

SELECT * FROM Opportunities WHERE Id >= 1

SELECT * FROM Opportunities WHERE Id <= 1

SELECT * FROM Opportunities WHERE Id > 1

SELECT * FROM Opportunities WHERE Id < 2

SELECT * FROM Opportunities WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of opportunities.
Amount	Integer	The amount the opportunity is worth..
CloseDate	Datetime	The date the opportunity is expected to close.
CreatedAt	Datetime	The date and time the mailing was created.
CurrencyType	String	The ISO code of the currency this opportunity is in.
Description	String	A description of the opportunity.
ExternalCreatedAt	Datetime	The date the opportunity was created in the external system.
MapLink	String	A link to the SamePlan MAP (Mutual Action Plan) associated with this opportunity.
MapNextSteps	String	The next event in the timeline that has yet to be completed for the SamePlan MAP.
MapStatus	String	The status of the SamePlan MAP (Mutual Action Plan) based on how well both parties are trending towards the plan.
Name	String	The name of the opportunity.
NextStep	String	The next step to take for the opportunity.
OpportunityType	String	The type of opportunity.
Probability	Integer	The chances of the opportunity succeeding represented as a percentage.
ProspectingRepId	String	The ID of the sales rep that prospects the opportunity.
SharingTeamId	String	The ID of the sharing team associated with this object. Access is currently in beta.
Tags	String	Tags associated with the opportunity.
TouchedAt	Datetime	The last time an event happened for an opportunity.
UpdatedAt	Datetime	The date the opportunity was last updated.
LinksSelf	String	Links Self.
AccountId	Integer	Account Id.
AccountType	String	Account type.
CreatorId	Integer	Creator Id.
CreatorDataType	String	Creator type.
OpportunityStageId	Integer	opportunityStage Id.
OpportunityStageType	String	OpportunityStage Type.
OwnerId	Integer	Owner Id.
OwnerType	String	Owner Type.
StageId	Integer	Stages Id.
StageType	String	Stages Type.
UpdaterId	Integer	Updater Id.
UpdaterType	String	Updater Type.
Type	String	Opportunities type.

OpportunityProspectRoles

Get details of prospect roles and associated with an opportunity.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Role supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM OpportunityProspectRoles WHERE Id = 1

SELECT * FROM OpportunityProspectRoles WHERE Id IN (1, 2)

SELECT * FROM OpportunityProspectRoles WHERE Id >= 1

SELECT * FROM OpportunityProspectRoles WHERE Id <= 1

SELECT * FROM OpportunityProspectRoles WHERE Id > 1

SELECT * FROM OpportunityProspectRoles WHERE Id < 2

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of opportunity prospect role.
CreatedAt	Datetime	The date and time the role was created.
Primary	Boolean	A boolean value indicating if this prospect is the primary contact within an opportunity.
Role	String	A string value representing the role.
UpdatedAt	Datetime	The date and time the role was last updated.
ProspectId	Integer	Prospect's Id.
OpportunityId	Integer	Opportunity's Id.

OpportunityStages

The stage an opportunity is in.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Name supports the '=,IN' operators.
OrderValue supports the '=' operator.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM OpportunityStages WHERE Id = 1

SELECT * FROM OpportunityStages WHERE Id IN (1, 2)

SELECT * FROM OpportunityStages WHERE Id >= 1

SELECT * FROM OpportunityStages WHERE Id <= 1

SELECT * FROM OpportunityStages WHERE Id > 1

SELECT * FROM OpportunityStages WHERE Id < 2

SELECT * FROM OpportunityStages WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE Name = 'Prospecting'

SELECT * FROM OpportunityStages WHERE OrderValue = 0

Columns


Name	Type	Description
Id [KEY]	Integer	Id of opportunity stage.
CreatedAt	Datetime	The date and time the opportunity stage was created.
Color	String	The color used to label and highlight the opportunity stage.
Name	String	The name of the opportunity stage.
OrderValue	Integer	The Order Value of the opportunity stage.
UpdatedAt	Datetime	The date and time the opportunity stage was last updated.
CreatorId	Integer	Creator Id.
OpportunityLinks	String	The opportunities currently associated with the opportunity stage.

Personas

A descriptor of a person used for categorizing prospects.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Name supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Personas WHERE Id = 1

SELECT * FROM Personas WHERE Id IN (1, 2)

SELECT * FROM Personas WHERE Id >= 1

SELECT * FROM Personas WHERE Id <= 1

SELECT * FROM Personas WHERE Id > 1

SELECT * FROM Personas WHERE Id < 2

SELECT * FROM Personas WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE Name = 'Prospecting'

SELECT * FROM Personas WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of persona.
CreatedAt	Datetime	The date and time the persona was created.
Description	String	A description of the persona.
Name	String	The name of the persona.
UpdatedAt	Datetime	The date and time the persona was last updated.
LinksSelf	String	Link self.
ProspectsLinks	String	The prospects with this persona.
Type	String	Type.

PhoneNumbers

Get details of prospect phone numbers.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
Number supports the '=,IN' operators.
Order supports the '=,>=,<=,>,<' operator.
PhoneType supports the '=' operator.
Status supports the '=' operator.
StatusChangedAt supports the '=,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM PhoneNumbers WHERE Id = 1

SELECT * FROM PhoneNumbers WHERE Id IN (1, 2)

SELECT * FROM PhoneNumbers WHERE Id >= 1

SELECT * FROM PhoneNumbers WHERE Id <= 1

SELECT * FROM PhoneNumbers WHERE Id > 1

SELECT * FROM PhoneNumbers WHERE Id < 2

SELECT * FROM PhoneNumbers WHERE StatusChangedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt >= '2022-01-25 01:02:02.0 ' AND StatusChangedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt = '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt < '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt > '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE Number = '+919876543210'

SELECT * FROM PhoneNumbers WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE PhoneType = 'work'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of phone numbers.
CountryCode	String	The country code.
CreatedAt	Datetime	The date and time the phone number was created.
Extension	String	Phone number extension.
Number	String	The phone number.
OrderValue	Integer	Ordered position in list of numbers.
PhoneType	String	Type of phone. Possible values are 'mobile', 'work', 'home', 'voip', 'other', etc.
RawNumber	String	Unformatted phone number.
Status	String	The status of the number.
StatusChangedAt	Datetime	Time the status was updated.
UpdatedAt	Datetime	The date and time the phone number was last updated.
LinksSelf	String	Link self.
ProspectId	Integer	Prospect's Id.
ProspectType	String	Prospect type.
Type	String	Type.

Profiles

Controls what you can see and do within Outreach.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
SpecialId supports the '=,IN' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Name supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Profiles WHERE Id = 1

SELECT * FROM Profiles WHERE Id IN (1, 2)

SELECT * FROM Profiles WHERE Id >= 1

SELECT * FROM Profiles WHERE Id <= 1

SELECT * FROM Profiles WHERE Id > 1

SELECT * FROM Profiles WHERE Id < 2

SELECT * FROM Profiles WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE Name = 'Admin'

SELECT * FROM Profiles WHERE Name IN ('Admin', 'Default')

SELECT * FROM Profiles WHERE SpecialId IN ('Admin', 'Default')

Columns


Name	Type	Description
Id [KEY]	Integer	Id of profile.
CreatedAt	Datetime	The date and time the team was created.
IsAdmin	Boolean	Flag that indicates whether the profile provides admin access.
Name	String	The name of the profile.
SpecialId	String	The special Id flag assigned to the profile.
UpdatedAt	Datetime	The date and time the team was last updated.
LinksSelf	String	Links self.
Type	String	type.

Prospects

Get Details of Prospects.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Emails supports the '=,IN' operators.
EngagedAt supports the '=,>=,<=,>,<' operators.
EngagedScore supports the '=,>=,<=,>,<' operators.
ExternalSource supports the '=,IN' operators.
FirstName supports the '=,IN' operators.
GithubUsername supports the '=,IN' operators.
LastName supports the '=,IN' operators.
LinkedInId supports the '=,IN' operators.
LinkedInSlug supports the '=,IN' operators.
SharingTeamId supports the '=,IN' operators.
StackOverflowId supports the '=,IN' operators.
TimeZone supports the '=,IN' operators.
Title supports the '=,IN' operators.
TouchedAt supports the '=,>=,<=,>,<' operators.
TwitterUsername supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Prospects WHERE Id = 1

SELECT * FROM Prospects WHERE Id IN (1, 2)

SELECT * FROM Prospects WHERE Id >= 1

SELECT * FROM Prospects WHERE Id <= 1

SELECT * FROM Prospects WHERE Id > 1

SELECT * FROM Prospects WHERE Id < 2

SELECT * FROM Prospects WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE EngagedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE Emails = '[email protected]'

SELECT * FROM Prospects WHERE FirstName = 'test'

SELECT * FROM Prospects WHERE LastName = 'test'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of Prospects.
AccountName	String	Name of prospects.
AddedAt	String	The date and time the prospect was added to any system.
AddressCity	String	The prospects city.
AddressCountry	String	The prospects country.
AddressState	String	The prospects state.
AddressStreet	String	The prospects street address.
AddressStreet2	String	The prospects second street address.
AddressZip	String	The prospects postal code.
AngelListUrl	String	The prospects AngelList URL.
AvailableAt	String	The date and time the prospect is available to contact again.
CallOptedOut	Boolean	Whether the prospect is opted out of calling or opted out in general if granular opt-out is not enabled.
CallsOptedAt	String	A string that represents whether a prospect has opted into or out of calls.
CallsOptStatus	String	The date and time the prospect opted in out of calls.
CampaignName	String	The name of the campaign the prospect is associated with.
ClickCount	Integer	The number of clicks the prospect has made since the last touch point.
Company	String	The name of the company the prospect works at If associated with an account this is the name of the account.
CompanyFollowers	String	The company Follwers.
CompanyFoundedAt	String	The date and time when company founded at.
CompanyIndustry	String	company Industry.
CompanyLinkedIn	String	company LinkedIn.
CompanyLinkedInEmployees	String	companyLinkedIn Employees.
CompanyLocality	String	company Locality.
CompanyNatural	String	company Natural.
CompanySize	String	company Size.
CompanyStartDate	String	company StartDate.
CompanyType	String	company Type.
ContactHistogram	String	The last 12 months of email contact history with the prospect with the current month being the last element.
CreatedAt	Datetime	The date and time the prospect was created.
DateOfBirth	String	The date the prospect was born.
Degree	String	The degrees the prospect has received.
EmailOptedOut	Boolean	Whether the prospect is opted out of email or opted out in general if granular opt-out is not enabled.
Emails	String	A list of email addresses associated with the prospect.
EmailsOptedAt	String	he date and time the prospect opted in out of emails.
EmailsOptStatus	String	The date and time the prospect opted in out of emails.
EngagedAt	Datetime	The date and time the prospect last engaged.
EngagedScore	Double	A number representing the quality of the lead based on the number of the prospects opens ,clicks and mailing replies.
EventName	String	The name of the event the prospect was met at.
ExternalId	String	A custom ID for the prospect often referencing an ID in an external system.
ExternalOwner	String	A custom owner for the prospect often referencing an ownering in an external system.
ExternalSource	String	The source of the resources creation.
FacebookUrl	String	The prospects Facebook URL.
FirstName	String	The first name of the prospect.
Gender	String	The gender of the prospect.
GithubUrl	String	The prospects GitHub URL.
GithubUsername	String	The prospects GitHub username.
GooglePlusUrl	String	The prospects Google+ URL..
GraduationDate	String	The graduation date of the prospect.
HomePhones	String	A list of home phone numbers associated with the prospect.
JobStartDate	String	The starting date of the prospects current job.
LastName	String	The last name of the prospect.
LinkedInConnections	String	The number of connections on the prospects LinkedIn profile.
LinkedInId	String	The prospects LinkedIn ID.
LinkedInSlug	String	The prospects LinkedIn slug.
LinkedInUrl	String	The prospects LinkedIn URL.
MiddleName	String	The middle name of the prospect.
MobilePhones	String	A list of mobile phone numbers associated with the prospect.
Name	String	The full name of the prospect.
Nickname	String	The nickname of the prospect.
Occupation	String	The occupation of the prospect.
OpenCount	Integer	The number of opens the prospect has made since the last touch point.
OptedOut	Boolean	A boolean value representing whether this prospect is currently opted out of all mailings.
OptedOutAt	String	The date and time the prospect opted out of emails.
OtherPhones	String	A list of other phone numbers associated with the prospect.
PersonalNote1	String	A note field related to the prospect.
PersonalNote2	String	A second note field related to the prospect.
PreferredContact	String	The preferred contact method for the prospect.
QuoraUrl	String	The prospects Quora URL.
Region	String	The primary geographic region of the prospect.
ReplyCount	Integer	The number of replies the prospect has made since the last touch point.
School	String	The schools the prospect has attended.
Score	String	A custom score given to measure the quality of the lead.
SharingTeamId	String	The ID of the sharing team associated with this object.
Source	String	A custom source representing where the lead was first acquired..
Specialties	String	description of the prospects specialties.
StackOverflowId	String	The prospects StackOverflow ID.
StackOverflowUrl	String	The prospects StackOverflow URL.
StageName	String	Stage Name.
Tags	String	A list of tag values associated with the account.
TimeZone	String	The prospects current timezone preferably in the IANA format.
TimeZoneIana	String	The prospects current IANA timezone if available.
TimeZoneInferred	String	The prospects current inferred IANA timezone if available.
Title	String	The title of the prospect.
TouchedAt	Datetime	The date and time the prospect was last touched.
TrashedAt	String	The date a prospect was soft deleted.
TwitterUrl	String	The prospects Twitter URL.
TwitterUsername	String	The prospects Twitter username.
UpdatedAt	Datetime	The date and time the prospect was last updated.
VoipPhones	String	A list of voip phone numbers associated with the prospect.
WebsiteUrl1	String	The URL of the prospects website.
WebsiteUrl2	String	The value of the prospects second website URL field.
WebsiteUrl3	String	The value of the prospects third website URL field.
WorkPhones	String	A list of work phone numbers associated with the prospect.
LinksSelf	String	Link Self.
AccountId	Integer	Account Id.
AccountType	String	Account Type.
BatchesLinks	String	Batches Links.
CallsLinks	String	Calls Link.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator Type.
TasksLinks	String	task links releated.
OwnerId	Integer	Owner Id.
OwnerType	String	Owner Type.
SequenceStatesLinks	String	SequenceStates Links.
UpdaterId	Integer	Updater Id.
UpdaterType	String	Updater Type.
Type	String	Type.

Recipients

Record for a recipient for some communication, such as email.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Recipients WHERE Id = 1

SELECT * FROM Recipients WHERE Id IN (1, 2)

SELECT * FROM Recipients WHERE Id >= 1

SELECT * FROM Recipients WHERE Id <= 1

SELECT * FROM Recipients WHERE Id > 1

SELECT * FROM Recipients WHERE Id < 2

Columns


Name	Type	Description
Id [KEY]	Integer	Id of Recipient.
CreatedAt	Datetime	The date and time the team was created.
EmailHash	String	Hash of email for recipient.
RecipientType	String	The type of action for the communcation to the recipient.
UpdatedAt	Datetime	The date and time the team was last updated.
Value	String	The recipient contact information.
LinksSelf	String	Link self.
Type	String	Type.

Roles

Get details of where you fall within your organizations structure.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Name supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Roles WHERE Id = 1

SELECT * FROM Roles WHERE Id IN (1, 2)

SELECT * FROM Roles WHERE Id >= 1

SELECT * FROM Roles WHERE Id <= 1

SELECT * FROM Roles WHERE Id > 1

SELECT * FROM Roles WHERE Id < 2

SELECT * FROM Roles WHERE Name = 'test'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of roles.
CreatedAt	Datetime	The date and time the team was created.
Name	String	The name of the role.
UpdatedAt	Datetime	The date and time the team was last updated.
LinksSelf	String	Link self.
ParentRoleLinks	String	Parent role links.
Type	String	Type.

Rulesets

A reusable set of behaviors to be applied to sequences.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
AutoResumeOotoProspects supports the '=' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
IncludeUnsubscribeLinks supports the '=' operator.
Name supports the '=,IN' operators.
PermitDuplicateProspects supports the '=,IN' operators.
SequenceExclusivity supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Rulesets WHERE Id = 1

SELECT * FROM Rulesets WHERE Id IN (1, 2)

SELECT * FROM Rulesets WHERE Id >= 1

SELECT * FROM Rulesets WHERE Id <= 1

SELECT * FROM Rulesets WHERE Id > 1

SELECT * FROM Rulesets WHERE Id < 2

SELECT * FROM Rulesets WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE AutoResumeOotoProspects = 'false'

SELECT * FROM Rulesets WHERE PermitDuplicateProspects = 'disallow'

SELECT * FROM Rulesets WHERE SequenceExclusivity = 'none'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of ruleset.
ApplyCompletedStageIn	Integer	The amount of time in seconds after the sequence has completed before the completedStage will be applied to the Prospect.
AutoResumeOotoProspects	Boolean	A boolean value indicating whether or not out-of-the-office Prospects will be automatically resumed.
AutoResumeOotoProspectsExpiresIn	Integer	The maximum amount of time in seconds to wait before opted-out Prospect will be resumed.
AutoResumeOotoProspectsIn	Integer	The default amount of time in seconds to wait before opted-out Prospects will be resumed.
CallOptOutAction	String	Determines if prospect can be added to sequences if they are opted out of calling.
ClicksNeededBeforeCallTaskCreated	Integer	The number of email clicks needed before a call task will be automatically created. This feature will be disabled unless a value is set.
CreatedAt	Datetime	The date and time the ruleset was created.
EmailOptOutAction	String	Determines if prospect can be added to sequences if they are opted out of emails.
IncludeUnsubscribeLinks	Boolean	A boolean value specifying whether or not to include unsubscribe links within emails.
MeetingBookedAction	String	Determines if a prospect is marked as finished when a meeting is booked.
MinimumProspectTouchedInterval	Integer	The minimum number of seconds that must elapse between when a Prospect was last contacted and when they may be added to a sequence.
Name	String	The name of the ruleset.
OotoAutoExtractionEnabled	Boolean	A boolean value determining whether to use out of the office return date auto extraction.
OpensNeededBeforeCallTaskCreated	Integer	The number of email opens needed before a call task will be automatically created.
PermitDuplicateProspects	String	A value determining whether a Prospect may be added to this Sequence multiple times or not. Possible values are 'allow', 'disallow', 'only_if_inactive', etc.
SequenceExclusivity	String	A value determining whether Prospects may be added to multiple different Sequences. Possible values are 'all_sequences', 'exclusive_sequences', 'none', etc.
SmsOptOutAction	String	Determines if prospect can be added to sequences if they are opted out of SMS.
SmsReceivedAction	String	Determines if a prospect is marked as finished when a text message is received.
StepOverridesEnabled	Boolean	A boolean value determining whether to allow users to customize step templates when adding to sequence.
OwnerId	Integer	Owner Id.
SequenceStatesLinks	String	Sequence states links.
UpdatedAt	Datetime	The date and time the ruleset was last updated.
LinksSelf	String	Link self.
Type	String	Type.

Sequences

Get details of sequences.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
ClickCount supports the '=,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
DeliverCount supports the '=,>=,<=,>,<' operators.
Name supports the '=,IN' operators.
EnabledAt supports the '=,>=,<=,>,<' operators.
LastUsedAt supports the '=,>=,<=,>,<' operators.
LockedAt supports the '=,>=,<=,>,<' operators.
OpenCount supports the '=,>=,<=,>,<' operators.
ReplyCount supports the '=,>=,<=,>,<' operators.
ThrottleCapacity supports the '=,>=,<=,>,<' operators.
ThrottleMaxAddsPerDay supports the '=,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.
ShareType supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM Sequences WHERE Id = 1

SELECT * FROM Sequences WHERE Id IN (1, 2)

SELECT * FROM Sequences WHERE Id >= 1

SELECT * FROM Sequences WHERE Id <= 1

SELECT * FROM Sequences WHERE Id > 1

SELECT * FROM Sequences WHERE Id < 2

SELECT * FROM Sequences WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE DeliverCount = 0

SELECT * FROM Sequences WHERE Name = 'test'

SELECT * FROM Sequences WHERE ThrottleMaxAddsPerDay = 1

SELECT * FROM Sequences WHERE ShareType = 'private'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of sequence template.
AutomationPercentage	Double	The percentage of auto_email sequence steps in this sequence.
BounceCount	Integer	The total count of bounced mailings during this sequence.
ClickCount	Integer	The total count of clicked mailings from this sequence.
CreatedAt	Datetime	The date and time the sequence was created.
DeliverCount	Integer	The total count of delivered mailings from this sequence.
Description	String	A custom description for the sequence.
DurationInDays	Integer	The total number of days it takes to get through this sequence.
Enabled	Boolean	A boolean value determining whether the sequence is enabled or not.
EnabledAt	Datetime	The date and time the sequence was enabled or null if currently disabled.
FailureCount	Integer	The total count of failed mailings from this sequence.
LastUsedAt	Datetime	The date and time the sequence was last used.
Locked	Boolean	A boolean value determining whether the sequence is locked or not.
LockedAt	Datetime	The date and time the sequence was locked or null if currently unlocked.
MaxActivations	Integer	The maximum number of prospects that can be associated with the sequence.
Name	String	The name or the sequence.
NegativeReplyCount	Integer	The total count of negative reply mailings from this sequence.
NeutralReplyCount	Integer	The total count of neutral reply mailings from this sequence.
NumContactedProspects	Integer	The total count of prospects who have been either called or emailed.
NumRepliedProspects	Integer	The total count of prospects who have been marked as replied.
OpenCount	Integer	The total count of opened mailings from this sequence.
OptOutCount	Integer	The total count of opted out mailings from this sequence.
PositiveReplyCount	Integer	The total count of positive reply mailings from this sequence.
PrimaryReplyAction	String	The action to take when the primary prospect replies. The allowed values are finish, continue, pause.
PrimaryReplyPauseDuration	Integer	The duration in seconds to pause for before automatically finishing after a reply from the primary prospect if the primaryReplyAction is pause.
ReplyCount	Integer	The total count of replied mailings from this sequence.
ScheduleCount	Integer	The total count of scheduled mailings from this sequence.
ScheduleIntervalType	String	The schedule interval type.
SecondaryReplyAction	String	The action to take when someone other than the primary prospect replies. The allowed values are finish, continue, pause.
SecondaryReplyPauseDuration	Integer	The duration in seconds to pause for before automatically finishing after a reply from anyone other than the primary prospect if the secondaryReplyAction is pause.
SequenceStepCount	Integer	The total number of sequence steps in this sequence.
SequenceType	String	The sequence type must be either date or interval. The allowed values are date, interval.
ShareType	String	The sequence share type. Possible values are 'private', 'read_only', 'shared', etc.
Tags	String	A list of tag values associated with the sequence.
ThrottleCapacity	Integer	The maximum number of associated sequence states per user that can be active at a one time.
ThrottleMaxAddsPerDay	Integer	The maximum number of associated sequence states per user that can be added to the sequence each day.
ThrottlePaused	Boolean	A boolean value determining whether the throttling of sequence states is paused or not.
ThrottlePausedAt	Datetime	The date and time the sequence state throttling was paused or null if not currently paused.
Transactional	Boolean	A boolean value determining whether prospect opt out preferences are respected.
UpdatedAt	Datetime	The date and time the sequence was last updated.
LinksSelf	String	Link self.
CreatorId	Integer	Creator Id.
OwnerId	Integer	Owner Id.
SequenceStatesLinks	String	Sequence states links.
UpdaterId	Integer	Updater Id.
RulesetId	Integer	Ruleset Id.
Type	String	Type.

SequenceStates

Get details of sequence states.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
ClickCount supports the '=,IN,>=,<=,>,<' operators.
CallCompletedAt supports the '=,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
DeliverCount supports the '=,IN,>=,<=,>,<' operators.
OpenCount supports the '=,IN,>=,<=,>,<' operators.
PauseReason supports the '=,IN' operators.
RepliedAt supports the '=,>=,<=,>,<' operators.
ReplyCount supports the '=,IN,>=,<=,>,<' operators.
State supports the '=' operator.
StateChangedAt supports the '=,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM SequenceStates WHERE Id = 1

SELECT * FROM SequenceStates WHERE Id IN (1, 2)

SELECT * FROM SequenceStates WHERE Id >= 1

SELECT * FROM SequenceStates WHERE Id <= 1

SELECT * FROM SequenceStates WHERE Id > 1

SELECT * FROM SequenceStates WHERE Id < 2

SELECT * FROM SequenceStates WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM SequenceStates WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM SequenceStates WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM SequenceStates WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM SequenceStates WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM SequenceStates WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM SequenceStates WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM SequenceStates WHERE DeliverCount = 0

SELECT * FROM SequenceStates WHERE Name = 'test'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of sequence state.
ActiveAt	Datetime	The date and time the sequence state was last active.
BounceCount	Integer	The total count of bounced mailings during this sequence state.
CallCompletedAt	Datetime	The date and time the sequence state last had a call completed.
ClickCount	Integer	The total count of clicked mailings from this sequence state.
CreatedAt	Datetime	The date and time the sequence state was created.
DeliverCount	Integer	The total count of delivered mailings from this sequence state.
ErrorReason	String	The reason for the most recent error.
FailureCount	Integer	The total count of failed mailings from this sequence state.
NegativeReplyCount	Integer	The total count of negative reply mailings from this sequence state.
NeutralReplyCount	Integer	The total count of neutral reply mailings from this sequence state.
OpenCount	Integer	The total count of opened mailings from this sequence state.
OptOutCount	Integer	The total count of opted out mailings from this sequence state.
PauseReason	String	The reason for the most recent pause.
PositiveReplyCount	Integer	The total count of positive reply mailings from this sequence state.
RepliedAt	Datetime	The date and time the sequence state last had a mailing reply.
ReplyCount	Integer	The total count of replied mailings from this sequence state.
ScheduleCount	Integer	The total count of scheduled mailings from this sequence state.
State	String	The current state of the sequence state.
StateChangedAt	Datetime	The date and time the sequence state's state last changed.
UpdatedAt	Datetime	The date and time the sequence state was last updated.
LinksSelf	String	Link self.
AccountId	Integer	Account Id.
AccountType	String	Account type.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator type.
MailboxId	Integer	Mailbox Id.
MailboxType	String	MailBox type.
ProspectId	Integer	Prospect Id.
ProspectType	String	Prospect type.
SequenceId	Integer	Sequence Id.
SequenceType	String	Sequence type.
SequenceStepId	Integer	Sequence step's Id.
SequenceStepType	String	Sequence step's type.
Type	String	Type.

SequenceSteps

Get details of sequence steps.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
OrderValue supports the '=,IN,>=,<=,>,<' operators.
StepType supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM SequenceSteps WHERE Id = 1

SELECT * FROM SequenceSteps WHERE Id IN (1, 2)

SELECT * FROM SequenceSteps WHERE Id >= 1

SELECT * FROM SequenceSteps WHERE Id <= 1

SELECT * FROM SequenceSteps WHERE Id > 1

SELECT * FROM SequenceSteps WHERE Id < 2

SELECT * FROM SequenceSteps WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM SequenceSteps WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM SequenceSteps WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM SequenceSteps WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM SequenceSteps WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM SequenceSteps WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM SequenceSteps WHERE StepType = 'task'

SELECT * FROM Stages WHERE OrderValue > 3 AND OrderValue < 7

Columns


Name	Type	Description
Id [KEY]	Integer	Id of sequence step.
BounceCount	Integer	The total count of bounced mailings during this sequence step.
ClickCount	Integer	The total count of clicked mailings from this sequence step.
CreatedAt	Datetime	The date and time the sequence step was created.
Date	Datetime	The date this step will activate.
DeliverCount	Integer	The total count of delivered mailings from this sequence step.
DisplayName	String	A human-readable display name that captures the steps type and OrderValue.
FailureCount	Integer	The total count of failed mailings from this sequence step.
Interval	Integer	The interval in minutes.
NegativeReplyCount	Integer	The total count of negative reply mailings from this sequence step.
NeutralReplyCount	Integer	The total count of neutral reply mailings from this sequence step.
OpenCount	Integer	The total count of opened mailings from this sequence step.
OptOutCount	Integer	The total count of opted out mailings from this sequence step.
OrderValue	Integer	The steps display Order value within its sequence.
PositiveReplyCount	Integer	The total count of positive reply mailings from this sequence step.
ReplyCount	Integer	The total count of replied mailings from this sequence step.
ScheduleCount	Integer	The total count of scheduled mailings from this sequence step.
StepType	String	The steps type. Possible values are 'auto_email', 'manual_email', 'call', 'task', etc.
TaskAutoskipDelay	Integer	The optional interval in seconds from when tasks created by this sequence step are overdue until they are automatically skipped.
TaskNote	String	An optional note to associate with created tasks.
UpdatedAt	Datetime	The date and time the sequence step was last updated.
LinksSelf	String	Link self.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator type.
SequenceId	Integer	Sequence Id.
SequenceType	String	Sequence type.
TaskPriorityId	Integer	Task priority Id.
TaskPriorityType	String	Task priority type.
UpdaterId	Integer	Updater Id.
UpdaterType	String	Updater type.
Type	String	Type.

SequenceTemplates

An object used to track which templates are in use by which sequence steps.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM SequenceTemplates WHERE Id = 1

SELECT * FROM SequenceTemplates WHERE Id IN (1, 2)

SELECT * FROM SequenceTemplates WHERE Id >= 1

SELECT * FROM SequenceTemplates WHERE Id <= 1

SELECT * FROM SequenceTemplates WHERE Id > 1

SELECT * FROM SequenceTemplates WHERE Id < 2

Columns


Name	Type	Description
Id [KEY]	Integer	Id of sequence template.
BounceCount	Integer	The total count of bounced mailings during this sequence template.
ClickCount	Integer	The total count of clicked mailings from this sequence template.
CreatedAt	Datetime	The date and time the sequence template was created.
DeliverCount	Integer	The total count of delivered mailings from this sequence template.
Enabled	Boolean	Boolean indicating if the sequence template is currently enabled.
EnabledAt	Datetime	Datetime for when the sequence template was enabled.
FailureCount	Integer	The total count of failed mailings from this sequence template.
IsReply	Boolean	Boolean indicating if the sequence template should be a reply email or a new thread.
NegativeReplyCount	Integer	The total count of negative reply mailings from this sequence template.
NeutralReplyCount	Integer	The total count of neutral reply mailings from this sequence template.
OpenCount	Integer	The total count of opened mailings from this sequence template.
OptOutCount	Integer	The total count of opted out mailings from this sequence template.
PositiveReplyCount	Integer	The total count of positive reply mailings from this sequence template.
ReplyCount	Integer	The total count of replied mailings from this sequence template.
ScheduleCount	Integer	The total count of scheduled mailings from this sequence template.
UpdatedAt	Datetime	The date and time the sequence template was last updated.
LinksSelf	String	Link self.
SequenceStepId	Integer	Sequence step Id.
SequenceStepType	String	Sequence step type.
TemplateId	Integer	Template Id.
TemplateType	String	Template type.
Type	String	Type.

Snippets

Piece of an email to be reused in multiple messages.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Name supports the '=,IN' operators.
ShareType supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Snippets WHERE Id = 1

SELECT * FROM Snippets WHERE Id IN (1, 2)

SELECT * FROM Snippets WHERE Id >= 1

SELECT * FROM Snippets WHERE Id <= 1

SELECT * FROM Snippets WHERE Id > 1

SELECT * FROM Snippets WHERE Id < 2

SELECT * FROM Snippets WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Snippets WHERE CreatedAt >= '2022-01-25 01:02:02.0' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Snippets WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Snippets WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Snippets WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Snippets WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Snippets WHERE ShareType = 'private'

SELECT * FROM Snippets WHERE Name = 'test'

SELECT * FROM Snippets WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Snippets WHERE UpdatedAt < '2022-02-25 01:02:02.0'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of sequence snippet.
BodyHtml	String	The HTML of the snippet.
BodyText	String	The text of the snippet.
ContainsCustomHtml	Boolean	Contains Custom HTML.
CreatedAt	Datetime	The date and time the snippet was created.
Name	String	The name of the snippet.
ShareType	String	The permissions for sharing the snippet. Possible values are 'private', 'shared', etc.
Tags	String	A list of tags associated with the snippet.
UpdatedAt	Datetime	The date and time the snippet was last updated.
LinksSelf	String	Link self.
ContentCategoryMembershipsLinks	String	Content category memberships links.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator type.
FavoritesLinks	String	Favorites links.
OwnerId	Integer	Owner Id.
OwnerType	String	Owner type.
UpdaterId	Integer	Updater Id.
UpdaterType	String	Updater type.
Type	String	Type.

Stages

The point in the process used for categorizing prospects.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Name supports the '=,IN' operators.
Order supports the '=,IN,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Stages WHERE Id = 1

SELECT * FROM Stages WHERE Id IN (1, 2)

SELECT * FROM Stages WHERE Id >= 1

SELECT * FROM Stages WHERE Id <= 1

SELECT * FROM Stages WHERE Id > 1

SELECT * FROM Stages WHERE Id < 2

SELECT * FROM Stages WHERE Name IN ('Interested', 'Replied')

SELECT * FROM Stages WHERE OrderValue > 3 AND OrderValue < 7

SELECT * FROM Stages WHERE OrderValue IN (3, 5, 7)

Columns


Name	Type	Description
Id [KEY]	Integer	Id of Stage.
Color	String	The color the stage label will be highlighted in the interface, specified as a hexidecimal value.
CreatedAt	Datetime	The date and time the stage was created.
Name	String	The name of the stage.
OrderValue	Integer	The stages display order value within the collection.
UpdatedAt	Datetime	The date and time the stage was last updated.
LinksSelf	String	Link self.
CreatorId	Integer	Creator Id.
UpdaterId	Integer	Updater Id.
ProspectsLinks	String	The prospects associated to the stage.
UpdaterData	String	The most recent updater of the stage.
Type	String	Type.

TaskPriorities

Descriptor of importance used for categorizing tasks.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Name supports the '=,IN' operators.
Weight supports the '=,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM TaskPriorities WHERE Id = 1

SELECT * FROM TaskPriorities WHERE Id IN (1, 2)

SELECT * FROM TaskPriorities WHERE Id >= 1

SELECT * FROM TaskPriorities WHERE Id <= 1

SELECT * FROM TaskPriorities WHERE Id > 1

SELECT * FROM TaskPriorities WHERE Id < 2

SELECT * FROM TaskPriorities WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM TaskPriorities WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM TaskPriorities WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM TaskPriorities WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM TaskPriorities WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM TaskPriorities WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM TaskPriorities WHERE Name = 'test'

SELECT * FROM TaskPriorities WHERE Weight > 10

SELECT * FROM TaskPriorities WHERE Weight = 10

SELECT * FROM TaskPriorities WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM TaskPriorities WHERE UpdatedAt < '2022-02-25 01:02:02.0'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of task priority.
Color	Long	The color the task priority label will be highlighted in the interface specified as a hexadecimal value.
CreatedAt	Datetime	The date and time the task priority was created.
Name	String	The name of the task priority.
UpdatedAt	Datetime	The date and time the task priority was last updated.
Weight	Integer	A relative value used for display order value task priorities are listed from lowest to highest weight.
LinksSelf	String	Links self.
SequenceStepsLinks	String	The associated sequence steps.
TasksLinks	String	The associated tasks.
Type	String	Type.

Tasks

An item that requires action to complete.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
AutoskipAt supports the '=,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
DueAt supports the '=,>=,<=,>,<' operators.
ScheduledAt supports the '=,>=,<=,>,<' operators.
State supports the '=,IN' operators.
StateChangedAt supports the '=,>=,<=,>,<' operators.
TaskType supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Tasks WHERE Id = 1

SELECT * FROM Tasks WHERE Id IN (1, 2)

SELECT * FROM Tasks WHERE Id >= 1

SELECT * FROM Tasks WHERE Id <= 1

SELECT * FROM Tasks WHERE Id > 1

SELECT * FROM Tasks WHERE Id < 2

SELECT * FROM Tasks WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE AutoskipAt = '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE DueAt = '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE ScheduledAt = '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE StateChangedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE TaskType = 'follow_up'

SELECT * FROM Tasks WHERE State = 'incomplete'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of Task.
Action	String	The action type of the task.
AutoskipAt	Datetime	The optional date and time when the task will automatically be skipped.
CompiledSequenceTemplateHtml	String	The compiled template HTML of incomplete SMS or LinkedIn tasks associated with a sequence.
Completed	Boolean	A boolean value indicating whether or not the task has been completed.
CompletedAt	Datetime	The date and time the task was completed.
CreatedAt	Datetime	The date and time the task was created.
DueAt	Datetime	The date and time the task is due.
Note	String	An optional note for the task.
OpportunityAssociation	String	The optional opportunity rule associated with the task.
ScheduledAt	Datetime	The date and time the pending task is scheduled for.
State	String	The current state of the task. Possible values are 'pending', 'incomplete', 'complete', etc.
StateChangedAt	Datetime	The date and time the state last changed.
TaskType	String	The type of task. Possible values are 'follow_up', 'manual', 'no_reply', 'sequence_open', 'sequence_click', 'sequence_step_call', 'sequence_step_email', 'sequence_step_linkedin_interact_with_post', 'sequence_step_linkedin_other', 'sequence_step_linkedin_send_connection_request', 'sequence_step_linkedin_send_message', 'sequence_step_linkedin_view_profile', 'sequence_step_sms', 'sequence_step_task', 'touch', etc.
UpdatedAt	Datetime	The date and time the task was last updated.
LinksSelf	String	Links self.
OwnerId	Integer	Owner Id.
OwnerType	String	Owner type.
ProspectId	Integer	Prospect Id.
ProspectType	String	Prospect's type.
ProspectAccountId	Integer	Prospect's account owner Id.
ProspectAccountType	String	Prospect's account type.
ProspectContactsData	String	Prospect's contacts.
ProspectContactsLinks	String	Prospect's contacts links.
ProspectContactsMetaCount	Integer	Prospect's meta count.
ProspectOwnerId	Integer	Prospect's owner Id.
ProspectOwnerType	String	Prospect's owner type.
ProspectPhoneNumbersData	String	Prospect's phone numbers.
ProspectPhoneNumbersLinks	String	Prospect's phone numbers links.
ProspectStageData	String	Prospect's stage.
SequenceId	Integer	The associated sequence Id.
SequenceType	String	The associated sequence type.
SequenceStateId	Integer	The associated sequence state Id.
SequenceStateType	String	The associated sequence state type.
SequenceStepId	Integer	The associated sequence step Id.
SequenceStepType	String	The associated sequence step type.
TaskPriorityId	Integer	The associated task priority Id.
TaskPriorityType	String	The associated task priority type.
TemplateId	Integer	The associated template Id.
Type	String	Types.

Teams

Get details of a group of users.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Name supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Teams WHERE Id = 1

SELECT * FROM Teams WHERE Id IN (1, 2)

SELECT * FROM Teams WHERE Id >= 1

SELECT * FROM Teams WHERE Id <= 1

SELECT * FROM Teams WHERE Id > 1

SELECT * FROM Teams WHERE Id < 2

SELECT * FROM Teams WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Teams WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Teams WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Teams WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Teams WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Teams WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Teams WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Teams WHERE Name = 'test'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of team.
Color	String	The color used to label and highlight the team.
CreatedAt	Datetime	The date and time the task was created.
Name	String	The name of the team.
ScimExternalId	String	The ID from the SCIM provisioning service used to create the team.
ScimSource	String	The name of the SCIM provisioning source used to create the team.
UpdatedAt	Datetime	The date and time the team was last updated.
LinksSelf	String	Link self.
ContentCategoriesId	Integer	The content categories that are assigned to the team.
ContentCategoriesLinks	String	The content categories links Id.
CreatorId	Integer	The creator Id.
CreatorType	String	Creator type.
UpdaterId	Integer	The most recent updater Id.
UpdaterType	String	The most recent updater type.
UsersId	Integer	User data.
UsersLinks	String	User links.
Type	String	Type.

Templates

Get details of reusable templates for building emails.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
ArchivedAt supports the '=,>=,<=,>,<' operators.
ClickCount supports the '=,IN,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
DeliverCount supports the '=,IN,>=,<=,>,<' operators.
LastUsedAt supports the '=,>=,<=,>,<' operators.
Name supports the '=,IN' operators.
OpenCount supports the '=,IN,>=,<=,>,<' operators.
ReplyCount supports the '=,IN,>=,<=,>,<' operators.
ShareType supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Templates WHERE Id = 1

SELECT * FROM Templates WHERE Id IN (1, 2)

SELECT * FROM Templates WHERE Id >= 1

SELECT * FROM Templates WHERE Id <= 1

SELECT * FROM Templates WHERE Id > 1

SELECT * FROM Templates WHERE Id < 2

SELECT * FROM Templates WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Templates WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Templates WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Templates WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Templates WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Templates WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Templates WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Templates WHERE Name = 'test'

SELECT * FROM Templates WHERE ShareType = 'read_only'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of Template.
Archived	Boolean	Boolean value indicating if the template has been archived.
ArchivedAt	Datetime	The date and time the template was archived.
BccRecipients	String	A list of default person and email address pairs to receive this template in the bcc field.
BodyHtml	String	The body HTML of the template.
BodyText	String	The body text of the template.
BounceCount	Integer	The total count of bounced mailings during this template.
CcRecipients	String	A list of default person and email address pairs to receive this template in the cc field.
ClickCount	Integer	The total count of clicked mailings from this template.
ClonedFromId	String	Cloned from Id.
ContainsCustomHtml	Boolean	Boolean value indicating if the template contains custom HTML.
CreatedAt	Datetime	The date and time the template was created.
DeliverCount	Integer	The total count of delivered mailings from this template.
FailureCount	Integer	The total count of failed mailings from this template.
LastUsedAt	Datetime	The last time the template was used.
Name	String	The name of the template.
NegativeReplyCount	Integer	The total count of negative reply mailings from this template.
NeutralReplyCount	Integer	The total count of neutral reply mailings from this template.
OpenCount	Integer	The total count of opened mailings from this template.
OptOutCount	Integer	The total count of opted out mailings from this template.
PositiveReplyCount	Integer	The total count of positive reply mailings from this template.
ReplyCount	Integer	The total count of replied mailings from this template.
ScheduleCount	Integer	The total count of scheduled mailings from this template.
ShareType	String	The share type must be one of. Possible values are 'read_only', 'private', 'shared', etc.
Subject	String	The subject line for the email to be sent.
Tags	String	A list of tag values associated with the template.
ToRecipients	String	A list of default person and email address pairs to receive this template in the To field.
TrackLinks	Boolean	Boolean value indicating if link tracking is enabled for the template.
TrackOpens	Boolean	Boolean value indicating if open tracking is enabled for the template.
UpdatedAt	Datetime	The date and time the template was last updated.
LinksSelf	String	Links self.
ContentCategoryMembershipsId	Integer	Content category memberships Id.
ContentCategoryMembershipsLinks	String	Content category memberships links.
CreatorId	Integer	The creator Id of the template.
CreatorType	String	The creator type of the template.
OwnerId	Integer	The Owner Id of the template.
OwnerType	String	The Owner type of the template.
RecipientsId	Integer	The Recipients Id.
RecipientsLinks	String	The Recipients links.
UpdaterId	Integer	The Updater Id of the template.
UpdaterType	String	The Updater type of the template.
Type	String	Type.

Users

Get deatils of The individual that uses the application.

Select

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

Id supports the '=,IN,>=,<=,>,<' operators.
CurrentSignInAt supports the '=,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Email supports the '=,IN' operators.
FirstName supports the '=,IN' operators.
LastName supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.
UserName supports the '=,IN' operators.

For example, the following query is processed server side:

SELECT * FROM Users WHERE Id = 1

SELECT * FROM Users WHERE Id IN (1, 2)

SELECT * FROM Users WHERE Id >= 1

SELECT * FROM Users WHERE Id <= 1

SELECT * FROM Users WHERE Id > 1

SELECT * FROM Users WHERE Id < 2

SELECT * FROM Users WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE CurrentSignInAt = '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE Email = '[email protected]'

SELECT * FROM Users WHERE FirstName = 'test'

SELECT * FROM Users WHERE LastName = 'test'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of Users.
AccountsViewId	String	The default smart view to load on the account index view.
ActivityNotificationsDisabled	Boolean	A boolean value whether the users activity notifications are disabled.
BounceWarningEmailEnabled	Boolean	A boolean value whether the users bounce warning emails are enabled.
BridgePhone	String	The telephone number of the users outbound bridge phone.
BridgePhoneExtension	String	The extension number of the users outbound bridge phone.
CallsViewId	String	The default smart view to load on the calls view.
ControlledTabDefault	String	The users preferred default tab to open when in task flow.
CreatedAt	Datetime	The date and time the user was created.
CurrentSignInAt	Datetime	The date and time the user most recently signed in.
DailyDigestEmailEnabled	Boolean	A boolean value whether the users daily digest emails are enabled.
DefaultRulesetId	Integer	The id of the default ruleset assigned to the user.
Duties	String	A collection of the users work roles.
DutiesSetAt	Datetime	The date and time the DutiesSetAt..
Email	String	The email address of the user.
EnableVoiceRecordings	Boolean	A boolean value whether the user has voice recordings enabled.
EngagementEmailsEnabled	Boolean	A boolean value whether the user has engagement emails enabled.
FirstName	String	The first name of the user.
InboundBridgePhone	String	The telephone number of the users inbound bridge phone.
InboundBridgePhoneExtension	String	The extension number of the users inbound bridge phone.
InboundCallBehavior	String	The behavior of inbound calls.
InboundPhoneType	String	The users type of telephone for inbound calls.
InboundVoicemailCustomMessageText	String	The message for inbound voicemails.
InboundVoicemailMessageTextVoice	String	The gender of the voice that reads the voicemail message.
InboundVoicemailPromptType	String	The type of inbound voicemail to use.
KaiaRecordingsViewId	String	The default smart view to load on the kaia recordings view.
KeepBridgePhoneConnected	Boolean	Whether to keep the users bridge phone connected in-between outbound calls.
LastName	String	The last name of the user.
LastSignInAt	Datetime	The date and time the user previously signed in.
Locked	Boolean	A boolean value whether the user is locked out of the application.
MailboxErrorEmailEnabled	Boolean	A boolean value whether the users mailbox error emails are enabled.
MeetingEngagementNotificationEnabled	Boolean	A boolean value whether the users meeting engagement notifications are enabled.
Name	String	The full name of the user.
NotificationsEnabled	Boolean	A boolean value whether the users notifications are enabled.
OceClickToDialEverywhere	Boolean	A boolean value indicating if phone calls will launch a call from Outreach.
OceGmailToolbar	Boolean	A boolean value indicating whether the Outreach Gmail toolbar is enabled.
OceGmailTrackingState	String	The users current email tracking settings when using Outreach Everywhere with GMail.
OceSalesforceEmailDecorating	Boolean	A boolean value indicating if emails are enabled in Outreach Everywhere with Salesforce.
OceSalesforcePhoneDecorating	Boolean	A boolean value indicating if phone calls are enabled in Outreach Everywhere with Salesforce.
OceUniversalTaskFlow	Boolean	A boolean value indicating whether Outreach Everywhere universal task flow is enabled.
OceWindowMode	Boolean	A boolean value indicating whether Outreach Everywhere window mode is enabled.
OnboardedAt	Datetime	The default smart view to load on the opportunity index view.
OpportunitiesViewId	String	The date and time the current password expires.
PasswordExpiresAt	Datetime	The country code of the users phone.
PhoneCountryCode	String	The telephone number of the users phone.
PhoneNumber	String	The users type of telephone for outbound calls.
PhoneType	String	A boolean value whether the users plugin related error notifications are enabled.
PluginAlertNotificationEnabled	Boolean	A string that represents Twilio data center used to connect to Twilio.
PreferredVoiceRegion	String	A boolean value whether the user prefers that a voice call comes from a local phone number.
PrefersLocalPresence	Boolean	The primary preferred timezone to use when scheduling meetings.
PrimaryTimezone	String	The default smart view to load on the prospect index view.
ProspectsViewId	String	The default smart view to load on the team performance reports view.
ReportsTeamPerfViewId	String	The default smart view to load on the reports view.
ReportsViewId	String	The ID from the SCIM provisioning service used to create the user.
ScimExternalId	String	The name of the SCIM provisioning source used to create the user.
ScimSource	String	The secondary preferred timezone to use when scheduling meetings.
SecondaryTimezone	String	A boolean value whether the users sender notifications are excluded.
SenderNotificationsExcluded	Boolean	The default smart view to load on the tasks index view.
TasksViewId	String	The default smart view to load on the teams index view.
TeamsViewId	String	The tertiary preferred timezone to use when scheduling meetings.
TertiaryTimezone	String	A boolean value whether to send the user email notifications when a text message is missed.
TextingEmailNotifications	Boolean	The users job title.
Title	String	A boolean value whether the users unknown reply emails are enabled.
UnknownReplyEmailEnabled	Boolean	The date and time the user was last updated.
UpdatedAt	Datetime	The globally unique ID GUID assigned to the user.
UserGuid	String	A reader friendly unique identifier of the user.
Username	String	A reader friendly unique identifier of the user.
UsersViewId	String	The default smart view to load on the users index view.
VoicemailNotificationEnabled	Boolean	A boolean value whether the users voicemail notifications are enabled.
WeeklyDigestEmailEnabled	Boolean	A boolean value whether the users weekly digest email are enabled.
LinksSelf	String	Link Self.
ContentCategoryMembershipsId	String	ContentCategoryMemberships Id.
CreatorId	Integer	The creator Id of the template.
CreatorType	String	The creator type of the template.
MailboxId	Integer	Mailboxes Id associated with the users.
MailboxType	String	Mailboxes Type associated with the users.
ProfileId	Integer	Profile Id associated with the users.
ProfileType	String	Profile type associated with the users.
RecipientsId	String	Recipients Id associated with the users.
RecipientsLinks	String	Recipients type associated with the users.
RoleId	Integer	Roles Id associated with the users.
RoleType	String	Roles Type associated with the users.
TeamsId	String	Teams Id associated with the users.
UpdaterId	Integer	The Updater Id of the template.
UpdaterType	String	The Updater type of the template.
Type	String	type.

UsersDuties

Get details of the individual that uses the application.

Select

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

UsersId supports the '=,IN,>=,<=,>,<' operators.
CurrentSignInAt supports the '=,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
Email supports the '=,IN' operators.
FirstName supports the '=,IN' operators.
LastName supports the '=,IN' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.
UserName supports the '=,IN' operators.
Locked supports the '=' operators.

For example, the following query is processed server side:

SELECT * FROM UsersDuties WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE CurrentSignInAt = '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE Email = '[email protected]'

SELECT * FROM UsersDuties WHERE FirstName = 'test'

SELECT * FROM UsersDuties WHERE LasttName = 'test'

Columns


Name	Type	Description
Id [KEY]	Integer	Id.
Name	String	Duty name.
DutyType	String	Duty type.

Pseudo-Columns

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
UsersId	Integer	Id of Users.
CreatedAt	Datetime	The date and time the user was created.
CurrentSignInAt	Datetime	The date and time the user most recently signed in.
Email	String	The email address of the user.
FirstName	String	The first name of the user.
LastName	String	The last name of the user.
Locked	Boolean	A boolean value indicating whether or not the user is locked out of the application.
UpdatedAt	Datetime	The globally unique ID GUID assigned to the user.
Username	String	A reader friendly unique identifier of the user.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with Outreach.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Outreach, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Outreach Stored Procedures


Name	Description
CustomDuties	Creates or Finds profile with provided Specialid
Finish	Finishes an active sequence state.
MarkComplete	Marks the task as complete.
Pause	Pauses an active sequence state
Resume	Resumes a paused sequence state
TaskAdvance	Advances the sequence state associated with the task to the next step in the sequence
TaskDeliver	Schedules the mailing associated with the task for delivery, if possible.
TaskReassignOwner	Reassigns the owner of a task
TaskReschedule	Reschedules a task by setting a new task due time
TaskSnooze	Snooze the task.
TaskUpdateNotes	Creates or finds profile with provided Specialid.
TestSend	Test if sending emails works from this mailbox.
TestSync	Test if syncing emails works from this mailbox.
UpdateOpportunityAssociation	Updates opportunity association of a task.

CustomDuties

Creates or Finds profile with provided Specialid

Stored Procedure Specific Information

Outreach allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. For example:

EXECUTE CustomDuties Name = test

Input


Name	Type	Required	Description
Name	String	True	The name of the role.

Result Set Columns


Name	Type	Description
Status	String	Execution status of the stored procedure.

Finish

Finishes an active sequence state.

Stored Procedure Specific Information

Outreach allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. For example:

EXECUTE Finish Id = 6

Input


Name	Type	Required	Description
Id	Integer	True	Id of Sequence State.

Result Set Columns


Name	Type	Description
Status	String	Execution status of the stored procedure.

MarkComplete

Marks the task as complete.

Stored Procedure Specific Information

Outreach allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. For example:

EXECUTE MarkComplete Id = 6

Input


Name	Type	Required	Description
Id	Integer	True	Task's Id.
CompletionNote	String	False	A note to attach to the associated prospect if there is one.
CompletionAction	String	False	For sequence step tasks, this specifies how to finish the sequence state.

Result Set Columns


Name	Type	Description
Status	String	Execution status of the stored procedure.

Pause

Pauses an active sequence state

Stored Procedure Specific Information

Outreach allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. For example:

EXECUTE Pause Id = 6

Input


Name	Type	Required	Description
Id	Integer	True	Id of Sequence State.

Result Set Columns


Name	Type	Description
Status	String	Execution status of the stored procedure.

Resume

Resumes a paused sequence state

Stored Procedure Specific Information

Outreach allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. For example:

EXECUTE Resume Id = 6

Input


Name	Type	Required	Description
Id	Integer	True	Id of Sequence State.

Result Set Columns


Name	Type	Description
Status	String	Execution status of the stored procedure.

TaskAdvance

Advances the sequence state associated with the task to the next step in the sequence

Stored Procedure Specific Information

Outreach allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. For example:

EXECUTE TaskAdvance Id = 1

Input


Name	Type	Required	Description
Id	Integer	True	ID of the task.

Result Set Columns


Name	Type	Description
Status	String	Execution status of the stored procedure.

TaskDeliver

Schedules the mailing associated with the task for delivery, if possible.

Stored Procedure Specific Information

Outreach allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. For example:

EXECUTE TaskDeliver Id = 1

Input


Name	Type	Required	Description
Id	Integer	True	ID of the task.

Result Set Columns


Name	Type	Description
Status	String	Execution status of the stored procedure.

TaskReassignOwner

Reassigns the owner of a task

Stored Procedure Specific Information

Outreach allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. For example:

EXECUTE TaskReassignOwner Id = 1, OwnerId = 1

Input


Name	Type	Required	Description
Id	Integer	True	ID of the task.
OwnerId	Integer	True	ID of the Owner.

Result Set Columns


Name	Type	Description
Status	String	Execution status of the stored procedure.

TaskReschedule

Reschedules a task by setting a new task due time

Stored Procedure Specific Information

Outreach allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. For example:

EXECUTE TaskReschedule Id = 1, DueAt = 2022-01-25

Input


Name	Type	Required	Description
Id	Integer	True	ID of the task.
DueAt	Date	True	The new time for the task to be due.

Result Set Columns


Name	Type	Description
Status	String	Execution status of the stored procedure.

TaskSnooze

Snooze the task.

Stored Procedure Specific Information

Outreach allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. For example:

EXECUTE TaskSnooze Id = 1

Input


Name	Type	Required	Description
Id	Integer	True	ID of the profile.
DueAt	Date	False	The new time for the task to be due.
MarkAsUrgent	Boolean	False	Whether to mark the task as urgent or not.

Result Set Columns


Name	Type	Description
Status	String	Execution status of the stored procedure.

TaskUpdateNotes

Creates or finds profile with provided Specialid.

Stored Procedure Specific Information

Outreach allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. For example:

EXECUTE TaskUpdateNotes Id = 1, Note = test

Input


Name	Type	Required	Description
Id	Integer	True	Task's Id.
Note	String	True	The note to set on the task.

Result Set Columns


Name	Type	Description
Status	String	Execution status of the stored procedure.

TestSend

Test if sending emails works from this mailbox.

Stored Procedure Specific Information

Outreach allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. For example:

EXECUTE TestSend Id = 1

Input


Name	Type	Required	Description
Id	Integer	True	ID of the Mailboxes.

Result Set Columns


Name	Type	Description
Status	String	Execution status of the stored procedure.

TestSync

Test if syncing emails works from this mailbox.

Stored Procedure Specific Information

Outreach allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. For example:

EXECUTE TestSync Id = 1

Input


Name	Type	Required	Description
Id	Integer	True	ID of the Mailboxes.

Result Set Columns


Name	Type	Description
Status	String	Execution status of the stored procedure.

UpdateOpportunityAssociation

Updates opportunity association of a task.

Stored Procedure Specific Information

Outreach allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. For example:

EXECUTE UpdateOpportunityAssociation Id = 1, OpportunityAssociation = test

Input


Name	Type	Required	Description
Id	Integer	True	ID of the tasks.
OpportunityAssociation	String	True	The opportunity to associate with the task.

Result Set Columns


Name	Type	Description
Status	String	Execution status of the stored procedure.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Outreach:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the SampleTable_1 table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='SampleTable_1'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SampleProcedure stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND IncludeResultColumns='True'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native Outreach procedure.

Pseudo-Columns


Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the SampleTable_1 table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='SampleTable_1'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns


Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

Connection String Options

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

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

Connection

Property	Description
APIVersion	The version of the Outreach API used.

OAuth

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.

SSL

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

Logging

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

Property	Description
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
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.

Connection

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

Property	Description
APIVersion	The version of the Outreach API used.

APIVersion

The version of the Outreach API used.

Data Type

string

Default Value

"v2"

Remarks

The version of the Outreach API used.

OAuth

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.

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.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud 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.

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.).

Data Type

string

Default Value

""

Remarks

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:

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

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.

Data Type

string

Default Value

""

Remarks

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.

SSL

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.

SSLServerCert

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

Data Type

string

Default Value

""

Remarks

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.

Logging

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

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

Schema

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

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

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.

Miscellaneous

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

Property	Description
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
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.

IncludeCustomFields

A boolean indicating if you would like to include custom fields in the column listing.

Data Type

bool

Default Value

true

Remarks

Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

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.

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud 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:

*=*

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

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.

Third Party Copyrights

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

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.

Cloud

Outreach - CData Cloud

Overview

Key Features

Getting Started

Connecting to Outreach

Accessing Data from CData Cloud Services

Establishing a Connection

Connecting to Outreach

Creating a Custom OAuth Application

Creating a Custom OAuth Application

Procedure

Data Model

Overview

Key Features

Views

Stored Procedures

Views

CData Cloud - Outreach Views

Accounts

Select

Columns

CallDispositions

Select

Columns

CallPurposes

Select

Columns

Calls

Select

Columns

ComplianceRequests

Select

Columns

ContentCategories

Select

Columns

ContentCategoryMemberships

Select

Columns

ContentCategoryOwnerships

Select

Columns

Duties

Select

Columns

EmailAddress

Select

Columns

Events

Select

Columns

Favorites

Select

Columns

MailAliases

Select

Columns

Mailbox

Select

Columns

Mailings

Select

Columns

Opportunities

Select

Columns

OpportunityProspectRoles

Select

Columns

OpportunityStages

Select

Columns

Personas

Select

Columns

PhoneNumbers

Select

Columns

Profiles