Outreach: List Users

List Outreach users.

Tool ID: outreach_list_users

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'outreach_list_users',
  {
    "newFilterSyntax": true,
    "page_size": 123,
    "page_after": "cursor_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute outreach_list_users --input '{
  "newFilterSyntax": true,
  "page_size": 123,
  "page_after": "cursor_123"
}' --json

Example response

The static output schema is not detailed enough to generate a reliable example. Use deepline tools get outreach_list_users --json for the complete live contract.

Input reference

Get a Collection of Users

Name	Type	Required	Default	Details
`payload.newFilterSyntax`	`boolean`	No	—	Use Outreach array/range filter syntax for literal commas and ranges.
`payload.page_size`	`integer`	No	—	Cursor page size sent as page[size]. Minimum: 1. Maximum: 1000.
`payload.page_after`	`string`	No	—	Cursor returned by the previous page.
`payload.page_before`	`string`	No	—	Cursor returned by the next page.
`payload.page_limit`	`integer`	No	—	Deprecated offset-pagination limit sent as page[limit]. Prefer page_size. Minimum: 1. Maximum: 1000.
`payload.page_offset`	`integer`	No	—	Deprecated offset-pagination offset sent as page[offset]. Prefer cursors. Minimum: 0. Maximum: 10000.
`payload.count`	`boolean`	No	—	Request Outreach total-count metadata; false is faster for pagination.
`payload.sort`	`string`	No	—	Comma-separated sortable fields; prefix a field with - for descending order.
`payload.include`	`string`	No	—	Comma-separated related resources to include.
`payload.provideAuthorizationMeta`	`boolean`	No	—	Request resource authorization metadata.
`payload.fields`	`object`	No	—	Sparse fieldsets keyed by JSON:API resource type, sent as fields[resource].
`payload.filters`	`object`	No	—	Endpoint-specific Outreach filters. Relationship attributes use keys such as owner[id].

This input schema is too large to embed without slowing the page. Get the complete live contract with deepline tools get outreach_list_users --json.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.data`	`array`	No	—	—
`result.data.data[].attributes`	`object`	No	—	The individual that uses the application. See https://developers.outreach.io/api/common-patterns/#invite-new-users for more information on inviting new users.
`result.data.data[].attributes.accountsViewId`	`integer \| null`	No	—	The default smart view to load on the account index view.
`result.data.data[].attributes.activityNotificationsDisabled`	`boolean \| null`	No	—	A boolean value whether the user’s activity notifications are disabled.
`result.data.data[].attributes.bounceWarningEmailEnabled`	`boolean \| null`	No	—	A boolean value whether the user’s bounce warning emails are enabled.
`result.data.data[].attributes.bridgePhone`	`string \| null`	No	—	The telephone number of the user’s outbound bridge phone. Maximum length: 255.
`result.data.data[].attributes.bridgePhoneExtension`	`string \| null`	No	—	The extension number of the user’s outbound bridge phone. Maximum length: 255.
`result.data.data[].attributes.callsViewId`	`integer \| null`	No	—	The default smart view to load on the calls view.
`result.data.data[].attributes.controlledTabDefault`	`string \| null`	No	—	The user’s preferred default tab to open when in task flow. Maximum length: 255.
`result.data.data[].attributes.createdAt`	`string \| null`	No	—	The date and time the user was created. Format: `date-time`.
`result.data.data[].attributes.currentSignInAt`	`string \| null`	No	—	The date and time the user most recently signed in. Format: `date-time`.
`result.data.data[].attributes.custom1`	`string \| null`	No	—	The value of the user’s first custom field. Maximum length: 225.
`result.data.data[].attributes.custom2`	`string \| null`	No	—	The value of the user’s second custom field. Maximum length: 225.
`result.data.data[].attributes.custom3`	`string \| null`	No	—	The value of the user’s third custom field. Maximum length: 225.
`result.data.data[].attributes.custom4`	`string \| null`	No	—	The value of the user’s fourth custom field. Maximum length: 225.
`result.data.data[].attributes.custom5`	`string \| null`	No	—	The value of the user’s fifth custom field. Maximum length: 225.
`result.data.data[].attributes.dailyDigestEmailEnabled`	`boolean \| null`	No	—	A boolean value whether the user’s daily digest emails are enabled.
`result.data.data[].attributes.defaultRulesetId`	`integer \| null`	No	—	The id of the default ruleset assigned to the user.
`result.data.data[].attributes.duties`	`object \| null`	No	—	A collection of the user’s work roles.
`result.data.data[].attributes.email`	`string \| null`	No	—	The email address of the user. Cannot be updated via the API. Format: `email`. Maximum length: 255.
`result.data.data[].attributes.enableVoiceRecordings`	`boolean \| null`	No	—	A boolean value whether the user has voice recordings enabled.
`result.data.data[].attributes.engagementEmailsEnabled`	`boolean \| null`	No	—	A boolean value whether the user has engagement emails enabled.
`result.data.data[].attributes.firstName`	`string \| null`	No	—	The first name of the user. Maximum length: 255.
`result.data.data[].attributes.inboundBridgePhone`	`string \| null`	No	—	The telephone number of the user’s inbound bridge phone. Maximum length: 255.
`result.data.data[].attributes.inboundBridgePhoneExtension`	`string \| null`	No	—	The extension number of the user’s inbound bridge phone. Maximum length: 255.
`result.data.data[].attributes.inboundCallBehavior`	`string \| null`	No	—	The behavior of inbound calls. Must be either “inbound_bridge” or “inbound_voicemail”. Maximum length: 255.
`result.data.data[].attributes.inboundPhoneType`	`string \| null`	No	—	The user’s type of telephone for inbound calls. Must be either “bridge”, “voip” or “bridge_and_voip”. Maximum length: 255.
`result.data.data[].attributes.inboundVoicemailCustomMessageText`	`string \| null`	No	—	The message for inbound voicemails (e.g. “Please leave a message and I will get back to you as soon I can”). Maximum length: 1024.
`result.data.data[].attributes.inboundVoicemailMessageTextVoice`	`string \| null`	No	—	The gender of the voice that reads the voicemail message. Must be either “man” or “woman”. Maximum length: 255.
`result.data.data[].attributes.inboundVoicemailPromptType`	`string \| null`	No	—	The type of inbound voicemail to use. Must be either “automated”, “recorded”, or “off”. Maximum length: 255.
`result.data.data[].attributes.jobRoleByName`	`string \| null`	No	—	The name of the job role (e.g. “SDR”). Maximum length: 255.
`result.data.data[].attributes.kaiaRecordingsViewId`	`integer \| null`	No	—	The default smart view to load on the kaia recordings view.
`result.data.data[].attributes.keepBridgePhoneConnected`	`boolean \| null`	No	—	Whether to keep the user’s bridge phone connected in-between outbound calls.
`result.data.data[].attributes.lastName`	`string \| null`	No	—	The last name of the user. Maximum length: 255.
`result.data.data[].attributes.lastSignInAt`	`string \| null`	No	—	The date and time the user previously signed in. Format: `date-time`.
`result.data.data[].attributes.locked`	`boolean \| null`	No	—	A boolean value whether the user is locked out of the application.
`result.data.data[].attributes.mailboxErrorEmailEnabled`	`boolean \| null`	No	—	A boolean value whether the user’s mailbox error emails are enabled.
`result.data.data[].attributes.meetingEngagementNotificationEnabled`	`boolean \| null`	No	—	A boolean value whether the user’s meeting engagement notifications are enabled.
`result.data.data[].attributes.name`	`string \| null`	No	—	The full name of the user.
`result.data.data[].attributes.notificationsEnabled`	`boolean \| null`	No	—	A boolean value whether the user’s notifications are enabled.
`result.data.data[].attributes.oceClickToDialEverywhere`	`boolean \| null`	No	—	A boolean value indicating if phone calls will launch a call from Outreach (Salesforce, Github, Gmail, LinkedIn, and Twitter).
`result.data.data[].attributes.oceGmailToolbar`	`boolean \| null`	No	—	A boolean value indicating whether the Outreach Gmail toolbar is enabled.
`result.data.data[].attributes.oceGmailTrackingState`	`string \| null`	No	—	The user’s current email tracking settings when using Outreach Everywhere with GMail. Maximum length: 255.
`result.data.data[].attributes.oceSalesforceEmailDecorating`	`boolean \| null`	No	—	A boolean value indicating if emails are enabled in Outreach Everywhere with Salesforce.
`result.data.data[].attributes.oceSalesforcePhoneDecorating`	`boolean \| null`	No	—	A boolean value indicating if phone calls are enabled in Outreach Everywhere with Salesforce.
`result.data.data[].attributes.oceUniversalTaskFlow`	`boolean \| null`	No	—	A boolean value indicating whether Outreach Everywhere universal task flow is enabled.
`result.data.data[].attributes.oceWindowMode`	`boolean \| null`	No	—	A boolean value indicating whether Outreach Everywhere window mode is enabled.
`result.data.data[].attributes.opportunitiesViewId`	`integer \| null`	No	—	The default smart view to load on the opportunity index view.
`result.data.data[].attributes.passwordExpiresAt`	`string \| null`	No	—	The date and time the current password expires. Format: `date-time`.

The table shows the first 50 fields. Use the live contract below for every field.

This output schema is too large to embed without slowing the page. Get the complete live contract with deepline tools get outreach_list_users --json.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Outreach: List Users

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation