Users

Get details of the individual that uses the application.

Select

The cmdlet 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 cmdlet.

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.

Cmdlets for Outreach

Users

Select

Columns