User

The individual that uses the application. See https://developers.outreach.io/api/common-patterns/#invite-new-users for more information on inviting new users.

accountsViewId
integer or null

The default smart view to load on the account index view.

activityNotificationsDisabled
boolean or null

A boolean value whether the user's activity notifications are disabled.

bounceWarningEmailEnabled
boolean or null

A boolean value whether the user's bounce warning emails are enabled.

bridgePhone
string or null <= 255 characters

The telephone number of the user's outbound bridge phone.

bridgePhoneExtension
string or null <= 255 characters

The extension number of the user's outbound bridge phone.

callsViewId
integer or null

The default smart view to load on the calls view.

controlledTabDefault
string or null <= 255 characters

The user's preferred default tab to open when in task flow.

createdAt
string or null <date-time>

The date and time the user was created.

currentSignInAt
string or null <date-time>

The date and time the user most recently signed in.

custom1
string or null <= 225 characters

The value of the user's first custom field.

custom2
string or null <= 225 characters

The value of the user's second custom field.

custom3
string or null <= 225 characters

The value of the user's third custom field.

custom4
string or null <= 225 characters

The value of the user's fourth custom field.

custom5
string or null <= 225 characters

The value of the user's fifth custom field.

dailyDigestEmailEnabled
boolean or null

A boolean value whether the user's daily digest emails are enabled.

defaultRulesetId
integer or null

The id of the default ruleset assigned to the user.

duties
object or null

A collection of the user's work roles.

email
string or null <email> <= 255 characters

The email address of the user. Cannot be updated via the API.

enableVoiceRecordings
boolean or null

A boolean value whether the user has voice recordings enabled.

engagementEmailsEnabled
boolean or null

A boolean value whether the user has engagement emails enabled.

firstName
string or null <= 255 characters

The first name of the user.

inboundBridgePhone
string or null <= 255 characters

The telephone number of the user's inbound bridge phone.

inboundBridgePhoneExtension
string or null <= 255 characters

The extension number of the user's inbound bridge phone.

inboundCallBehavior
string or null <= 255 characters

The behavior of inbound calls. Must be either "inbound_bridge" or "inbound_voicemail".

inboundPhoneType
string or null <= 255 characters

The user's type of telephone for inbound calls. Must be either "bridge", "voip" or "bridge_and_voip".

inboundVoicemailCustomMessageText
string or null <= 1024 characters

The message for inbound voicemails (e.g. "Please leave a message and I will get back to you as soon I can").

inboundVoicemailMessageTextVoice
string or null <= 255 characters

The gender of the voice that reads the voicemail message. Must be either "man" or "woman".

inboundVoicemailPromptType
string or null <= 255 characters

The type of inbound voicemail to use. Must be either "automated", "recorded", or "off".

kaiaRecordingsViewId
integer or null

The default smart view to load on the kaia recordings view.

keepBridgePhoneConnected
boolean or null

Whether to keep the user's bridge phone connected in-between outbound calls.

lastName
string or null <= 255 characters

The last name of the user.

lastSignInAt
string or null <date-time>

The date and time the user previously signed in.

locked
boolean or null

A boolean value whether the user is locked out of the application.

mailboxErrorEmailEnabled
boolean or null

A boolean value whether the user's mailbox error emails are enabled.

meetingEngagementNotificationEnabled
boolean or null

A boolean value whether the user's meeting engagement notifications are enabled.

name
string or null

The full name of the user.

notificationsEnabled
boolean or null

A boolean value whether the user's notifications are enabled.

oceClickToDialEverywhere
boolean or null

A boolean value indicating if phone calls will launch a call from Outreach (Salesforce, Github, Gmail, LinkedIn, and Twitter).

oceGmailToolbar
boolean or null

A boolean value indicating whether the Outreach Gmail toolbar is enabled.

oceGmailTrackingState
string or null <= 255 characters

The user's current email tracking settings when using Outreach Everywhere with GMail.

oceSalesforceEmailDecorating
boolean or null

A boolean value indicating if emails are enabled in Outreach Everywhere with Salesforce.

oceSalesforcePhoneDecorating
boolean or null

A boolean value indicating if phone calls are enabled in Outreach Everywhere with Salesforce.

oceUniversalTaskFlow
boolean or null

A boolean value indicating whether Outreach Everywhere universal task flow is enabled.

oceWindowMode
boolean or null

A boolean value indicating whether Outreach Everywhere window mode is enabled.

opportunitiesViewId
integer or null

The default smart view to load on the opportunity index view.

passwordExpiresAt
string or null <date-time>

The date and time the current password expires.

phoneCountryCode
string or null <= 2 characters

The country code of the user's phone.

phoneNumber
string or null

The telephone number of the user's phone.

phoneType
string or null <= 255 characters

The user's type of telephone for outbound calls. Must be either "bridge" or "voip".

pluginAlertNotificationEnabled
boolean or null

A boolean value whether the user's plugin related error notifications are enabled.

preferredVoiceRegion
string or null <= 255 characters

A string that represents Twilio data center used to connect to Twilio.

prefersLocalPresence
boolean or null

A boolean value whether the user prefers that a voice call comes from a local phone number.

primaryTimezone
string or null <= 255 characters

The primary preferred timezone to use when scheduling meetings.

prospectsViewId
integer or null

The default smart view to load on the prospect index view.

reportsTeamPerfViewId
integer or null

The default smart view to load on the team performance reports view.

reportsViewId
integer or null

The default smart view to load on the reports view.

scimExternalId
string or null <= 255 characters

The ID from the SCIM provisioning service used to create the user.

scimSource
string or null <= 255 characters

The name of the SCIM provisioning source used to create the user.

secondaryTimezone
string or null <= 255 characters

The secondary preferred timezone to use when scheduling meetings.

senderNotificationsExcluded
boolean or null

A boolean value whether the user's sender notifications are excluded.

tasksViewId
integer or null

The default smart view to load on the tasks index view.

teamsViewId
integer or null

The default smart view to load on the teams index view.

tertiaryTimezone
string or null <= 255 characters

The tertiary preferred timezone to use when scheduling meetings.

textingEmailNotifications
boolean or null

A boolean value whether to send the user email notifications when a text message is missed.

title
string or null <= 255 characters

The user's job title (e.g. "Staff Accountant").

unknownReplyEmailEnabled
boolean or null

A boolean value whether the user's unknown reply emails are enabled.

updatedAt
string or null <date-time>

The date and time the user was last updated.

userGuid
string or null

The globally unique ID (GUID) assigned to the user.

username
string or null <= 255 characters

A reader friendly unique identifier of the user.

usersViewId
integer or null

The default smart view to load on the users index view.

voicemailNotificationEnabled
boolean or null

A boolean value whether the user's voicemail notifications are enabled.

weeklyDigestEmailEnabled
boolean or null

A boolean value whether the user's weekly digest email are enabled.

{
  • "accountsViewId": 0,
  • "activityNotificationsDisabled": true,
  • "bounceWarningEmailEnabled": true,
  • "bridgePhone": "string",
  • "bridgePhoneExtension": "string",
  • "callsViewId": 0,
  • "controlledTabDefault": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "currentSignInAt": "2019-08-24T14:15:22Z",
  • "custom1": "string",
  • "custom2": "string",
  • "custom3": "string",
  • "custom4": "string",
  • "custom5": "string",
  • "dailyDigestEmailEnabled": true,
  • "defaultRulesetId": 0,
  • "duties": { },
  • "email": "user@example.com",
  • "enableVoiceRecordings": true,
  • "engagementEmailsEnabled": true,
  • "firstName": "string",
  • "inboundBridgePhone": "string",
  • "inboundBridgePhoneExtension": "string",
  • "inboundCallBehavior": "string",
  • "inboundPhoneType": "string",
  • "inboundVoicemailCustomMessageText": "string",
  • "inboundVoicemailMessageTextVoice": "string",
  • "inboundVoicemailPromptType": "string",
  • "kaiaRecordingsViewId": 0,
  • "keepBridgePhoneConnected": true,
  • "lastName": "string",
  • "lastSignInAt": "2019-08-24T14:15:22Z",
  • "locked": true,
  • "mailboxErrorEmailEnabled": true,
  • "meetingEngagementNotificationEnabled": true,
  • "name": "string",
  • "notificationsEnabled": true,
  • "oceClickToDialEverywhere": true,
  • "oceGmailToolbar": true,
  • "oceGmailTrackingState": "string",
  • "oceSalesforceEmailDecorating": true,
  • "oceSalesforcePhoneDecorating": true,
  • "oceUniversalTaskFlow": true,
  • "oceWindowMode": true,
  • "opportunitiesViewId": 0,
  • "passwordExpiresAt": "2019-08-24T14:15:22Z",
  • "phoneCountryCode": "st",
  • "phoneNumber": "string",
  • "phoneType": "string",
  • "pluginAlertNotificationEnabled": true,
  • "preferredVoiceRegion": "string",
  • "prefersLocalPresence": true,
  • "primaryTimezone": "string",
  • "prospectsViewId": 0,
  • "reportsTeamPerfViewId": 0,
  • "reportsViewId": 0,
  • "scimExternalId": "string",
  • "scimSource": "string",
  • "secondaryTimezone": "string",
  • "senderNotificationsExcluded": true,
  • "tasksViewId": 0,
  • "teamsViewId": 0,
  • "tertiaryTimezone": "string",
  • "textingEmailNotifications": true,
  • "title": "string",
  • "unknownReplyEmailEnabled": true,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "userGuid": "string",
  • "username": "string",
  • "usersViewId": 0,
  • "voicemailNotificationEnabled": true,
  • "weeklyDigestEmailEnabled": true
}

User Relationships

object
object

The calendar associated with the user.

object

The groupings of sequences, snippets and templates that this user has access to. Relationship contentCategories cannot be used as a filter.

object
object

The creator of the user. Relationship creator cannot be used as a filter.

object
object

The user favorited by the user.

object
object

The default mailbox associated with the user. Relationship mailbox cannot be used as a filter.

object

All mailboxes associated with the user. Relationship mailboxes cannot be used as a filter.

object

The list of outbound voicemails associated with the user.

object

The default phone to use outbound or inbound voice calls.

object

The list of phones associated with the user.

object

The user's profile in Outreach. You can use only the attribute id to filter users by profile (e.g. filter[profile][id]=X).

object

Recipients that will be included by default in all emails composed by user. Relationship recipients cannot be used as a filter.

object

The role associated with the user. You can use only the attribute id to filter users by role (e.g. filter[role][id]=X).

object
object

The default phone to use for SMS messaging.

object

The teams the user belongs to. You can use only the attribute id to filter users by teams (e.g. filter[teams][id]=X).

object

The most recent updater of the user. Relationship updater cannot be used as a filter.

object

The list of voicemail prompts associated with the user.

{
  • "batches": {},
  • "calendar": {},
  • "contentCategories": {},
  • "contentCategoryOwnerships": {
    },
  • "creator": {},
  • "directAssignedTeams": {},
  • "favorites": {},
  • "jobRole": {},
  • "mailbox": {},
  • "mailboxes": {},
  • "outboundVoicemails": {
    },
  • "phone": {},
  • "phones": {},
  • "profile": {},
  • "recipients": {},
  • "role": {},
  • "roleAssignedTeams": {},
  • "smsPhone": {},
  • "teams": {},
  • "updater": {},
  • "voicemailPrompts": {}
}

User Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
dataConnections The set of connections a given User has to external sources. provideDataConnections

⌵ User Actions

Get a Collection of Users

SecuritybearerAuth and s2sAuthToken
Responses
200

OK

422

JSON error message

get/users
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New User
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/users
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Get a User by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/users/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update a User
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/users/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}