> ## Documentation Index > Fetch the complete documentation index at: https://deepline.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Outreach: Get User > Read an Outreach user by ID. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost. Read an Outreach user by ID. > [!NOTE] > > Tool ID: `outreach_get_user` ## Run this action Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing. ```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} import { Deepline } from 'deepline'; const deepline = await Deepline.connect(); const result = await deepline.tools.execute( 'outreach_get_user', { "id": 123 }, ); console.log(result.toolResponse.raw); ``` ### CLI ```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} deepline tools execute outreach_get_user --input '{ "id": 123 }' --json ``` ## Example response The static output schema lacks the details for a reliable example. Use `deepline describe outreach_get_user --json` for the complete live contract. ## Input reference Get a User by ID | Name | Type | Required | Default | Details | | - | - | - | - | - | | `payload.id` | `integer` | Yes | — | — | | `payload.include` | `string` | No | — | Comma-separated related resources to include. | | `payload.fields` | `object` | No | — | Sparse fieldsets keyed by JSON:API resource type, sent as fields\[resource]. |
Show raw input schema ### Input JSON Schema ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} { "type": "object", "description": "Get a User by ID", "properties": { "id": { "type": "integer" }, "include": { "type": "string", "description": "Comma-separated related resources to include." }, "fields": { "type": "object", "description": "Sparse fieldsets keyed by JSON:API resource type, sent as fields[resource].", "properties": { "account": { "type": "string" }, "accountNote": { "type": "string" }, "auditLog": { "type": "string" }, "batch": { "type": "string" }, "batchItem": { "type": "string" }, "call": { "type": "string" }, "callDisposition": { "type": "string" }, "callPurpose": { "type": "string" }, "complianceRequest": { "type": "string" }, "contentCategory": { "type": "string" }, "contentCategoryMembership": { "type": "string" }, "contentCategoryOwnership": { "type": "string" }, "customDuty": { "type": "string" }, "duty": { "type": "string" }, "emailAddress": { "type": "string" }, "event": { "type": "string" }, "favorite": { "type": "string" }, "import": { "type": "string" }, "kaiaRecording": { "type": "string" }, "kaiaVoiceImport": { "type": "string" }, "mailAlias": { "type": "string" }, "mailbox": { "type": "string" }, "mailing": { "type": "string" }, "opportunity": { "type": "string" }, "opportunityProspectRole": { "type": "string" }, "opportunityStage": { "type": "string" }, "orgSetting": { "type": "string" }, "persona": { "type": "string" }, "phoneNumber": { "type": "string" }, "product": { "type": "string" }, "profile": { "type": "string" }, "prospect": { "type": "string" }, "prospectNote": { "type": "string" }, "purchase": { "type": "string" }, "recipient": { "type": "string" }, "role": { "type": "string" }, "ruleset": { "type": "string" }, "sequence": { "type": "string" }, "sequenceState": { "type": "string" }, "sequenceStep": { "type": "string" }, "sequenceTemplate": { "type": "string" }, "snippet": { "type": "string" }, "stage": { "type": "string" }, "task": { "type": "string" }, "taskDisposition": { "type": "string" }, "taskPriority": { "type": "string" }, "taskPurpose": { "type": "string" }, "team": { "type": "string" }, "template": { "type": "string" }, "user": { "type": "string" }, "webhook": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id" ], "additionalProperties": false } ```
## Output reference Standard tool result payload. | Name | Type | Required | Default | Details | | - | - | - | - | - | | `result.data` | `object` | Yes | — | Provider response payload. | | `result.data.data` | `object` | No | — | — | | `result.data.data.attributes` | `object` | No | — | The individual that uses the application. See [https://developers.outreach.io/api/common-patterns/#invite-new-users](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. > [!NOTE] > > This output schema is too large for an inline display. Read the complete live contract with `deepline describe outreach_get_user --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. ## Related documentation * [Outreach provider guide](https://deepline.com/docs/providers/outreach/guide.md) * [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md) * [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md) * [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.