> ## 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 Action Doc: Inputs, Cost & CLI Example
> List Outreach users. Outreach Outreach List Users docs include request fields, response shape, pricing notes, and Deepline CLI examples.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=outreach_list_users:{}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ---------------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
| `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]. |
| `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. |
| `payload.page_offset` | `integer` | No | | Deprecated offset-pagination offset sent as page\[offset]. Prefer cursors. |
| `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]. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Get a Collection of Users",
"properties": {
"newFilterSyntax": {
"type": "boolean",
"description": "Use Outreach array/range filter syntax for literal commas and ranges."
},
"page_size": {
"type": "integer",
"description": "Cursor page size sent as page[size].",
"minimum": 1,
"maximum": 1000
},
"page_after": {
"type": "string",
"description": "Cursor returned by the previous page."
},
"page_before": {
"type": "string",
"description": "Cursor returned by the next page."
},
"page_limit": {
"type": "integer",
"description": "Deprecated offset-pagination limit sent as page[limit]. Prefer page_size.",
"minimum": 1,
"maximum": 1000
},
"page_offset": {
"type": "integer",
"description": "Deprecated offset-pagination offset sent as page[offset]. Prefer cursors.",
"minimum": 0,
"maximum": 10000
},
"count": {
"type": "boolean",
"description": "Request Outreach total-count metadata; false is faster for pagination."
},
"sort": {
"type": "string",
"description": "Comma-separated sortable fields; prefix a field with - for descending order."
},
"include": {
"type": "string",
"description": "Comma-separated related resources to include."
},
"provideAuthorizationMeta": {
"type": "boolean",
"description": "Request resource authorization metadata."
},
"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
},
"filters": {
"type": "object",
"description": "Endpoint-specific Outreach filters. Relationship attributes use keys such as owner[id].",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
{
"type": "object",
"description": "Inclusive range bounds. Requires newFilterSyntax=true and becomes filter[field][gte]/[lte].",
"minProperties": 1,
"properties": {
"gte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
]
},
"id[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"id[lte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
{
"type": "object",
"description": "Inclusive range bounds. Requires newFilterSyntax=true and becomes filter[field][gte]/[lte].",
"minProperties": 1,
"properties": {
"gte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
]
},
"createdAt[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"createdAt[lte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
{
"type": "object",
"description": "Inclusive range bounds. Requires newFilterSyntax=true and becomes filter[field][gte]/[lte].",
"minProperties": 1,
"properties": {
"gte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
]
},
"updatedAt[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"updatedAt[lte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"currentSignInAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
{
"type": "object",
"description": "Inclusive range bounds. Requires newFilterSyntax=true and becomes filter[field][gte]/[lte].",
"minProperties": 1,
"properties": {
"gte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
]
},
"currentSignInAt[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"currentSignInAt[lte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
{
"type": "object",
"description": "Inclusive range bounds. Requires newFilterSyntax=true and becomes filter[field][gte]/[lte].",
"minProperties": 1,
"properties": {
"gte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
]
},
"email[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"email[lte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"firstName": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
{
"type": "object",
"description": "Inclusive range bounds. Requires newFilterSyntax=true and becomes filter[field][gte]/[lte].",
"minProperties": 1,
"properties": {
"gte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
]
},
"firstName[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"firstName[lte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lastName": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
{
"type": "object",
"description": "Inclusive range bounds. Requires newFilterSyntax=true and becomes filter[field][gte]/[lte].",
"minProperties": 1,
"properties": {
"gte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
]
},
"lastName[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lastName[lte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"locked": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
{
"type": "object",
"description": "Inclusive range bounds. Requires newFilterSyntax=true and becomes filter[field][gte]/[lte].",
"minProperties": 1,
"properties": {
"gte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
]
},
"locked[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"locked[lte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
{
"type": "object",
"description": "Inclusive range bounds. Requires newFilterSyntax=true and becomes filter[field][gte]/[lte].",
"minProperties": 1,
"properties": {
"gte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
]
},
"username[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"username[lte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"profile[id]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
{
"type": "object",
"description": "Inclusive range bounds. Requires newFilterSyntax=true and becomes filter[field][gte]/[lte].",
"minProperties": 1,
"properties": {
"gte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
]
},
"role[id]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
{
"type": "object",
"description": "Inclusive range bounds. Requires newFilterSyntax=true and becomes filter[field][gte]/[lte].",
"minProperties": 1,
"properties": {
"gte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
]
},
"teams[id]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
{
"type": "object",
"description": "Inclusive range bounds. Requires newFilterSyntax=true and becomes filter[field][gte]/[lte].",
"minProperties": 1,
"properties": {
"gte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lte": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"description": "Provider response payload.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "The individual that uses the application. See https://developers.outreach.io/api/common-patterns/#invite-new-users for more information on inviting new users.",
"properties": {
"accountsViewId": {
"type": [
"integer",
"null"
],
"description": "The default smart view to load on the account index view."
},
"activityNotificationsDisabled": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user's activity notifications are disabled."
},
"bounceWarningEmailEnabled": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user's bounce warning emails are enabled."
},
"bridgePhone": {
"type": [
"string",
"null"
],
"description": "The telephone number of the user's outbound bridge phone.",
"maxLength": 255
},
"bridgePhoneExtension": {
"type": [
"string",
"null"
],
"description": "The extension number of the user's outbound bridge phone.",
"maxLength": 255
},
"callsViewId": {
"type": [
"integer",
"null"
],
"description": "The default smart view to load on the calls view."
},
"controlledTabDefault": {
"type": [
"string",
"null"
],
"description": "The user's preferred default tab to open when in task flow.",
"maxLength": 255
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "The date and time the user was created.",
"format": "date-time"
},
"currentSignInAt": {
"type": [
"string",
"null"
],
"description": "The date and time the user most recently signed in.",
"format": "date-time"
},
"custom1": {
"type": [
"string",
"null"
],
"description": "The value of the user's first custom field.",
"maxLength": 225
},
"custom2": {
"type": [
"string",
"null"
],
"description": "The value of the user's second custom field.",
"maxLength": 225
},
"custom3": {
"type": [
"string",
"null"
],
"description": "The value of the user's third custom field.",
"maxLength": 225
},
"custom4": {
"type": [
"string",
"null"
],
"description": "The value of the user's fourth custom field.",
"maxLength": 225
},
"custom5": {
"type": [
"string",
"null"
],
"description": "The value of the user's fifth custom field.",
"maxLength": 225
},
"dailyDigestEmailEnabled": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user's daily digest emails are enabled."
},
"defaultRulesetId": {
"type": [
"integer",
"null"
],
"description": "The id of the default ruleset assigned to the user."
},
"duties": {
"type": [
"object",
"null"
],
"description": "A collection of the user's work roles."
},
"email": {
"type": [
"string",
"null"
],
"description": "The email address of the user. Cannot be updated via the API.",
"maxLength": 255,
"format": "email"
},
"enableVoiceRecordings": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user has voice recordings enabled."
},
"engagementEmailsEnabled": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user has engagement emails enabled."
},
"firstName": {
"type": [
"string",
"null"
],
"description": "The first name of the user.",
"maxLength": 255
},
"inboundBridgePhone": {
"type": [
"string",
"null"
],
"description": "The telephone number of the user's inbound bridge phone.",
"maxLength": 255
},
"inboundBridgePhoneExtension": {
"type": [
"string",
"null"
],
"description": "The extension number of the user's inbound bridge phone.",
"maxLength": 255
},
"inboundCallBehavior": {
"type": [
"string",
"null"
],
"description": "The behavior of inbound calls. Must be either \"inbound_bridge\" or \"inbound_voicemail\".",
"maxLength": 255
},
"inboundPhoneType": {
"type": [
"string",
"null"
],
"description": "The user's type of telephone for inbound calls. Must be either \"bridge\", \"voip\" or \"bridge_and_voip\".",
"maxLength": 255
},
"inboundVoicemailCustomMessageText": {
"type": [
"string",
"null"
],
"description": "The message for inbound voicemails (e.g. \"Please leave a message and I will get back to you as soon I can\").",
"maxLength": 1024
},
"inboundVoicemailMessageTextVoice": {
"type": [
"string",
"null"
],
"description": "The gender of the voice that reads the voicemail message. Must be either \"man\" or \"woman\".",
"maxLength": 255
},
"inboundVoicemailPromptType": {
"type": [
"string",
"null"
],
"description": "The type of inbound voicemail to use. Must be either \"automated\", \"recorded\", or \"off\".",
"maxLength": 255
},
"jobRoleByName": {
"type": [
"string",
"null"
],
"description": "The name of the job role (e.g. \"SDR\").",
"maxLength": 255
},
"kaiaRecordingsViewId": {
"type": [
"integer",
"null"
],
"description": "The default smart view to load on the kaia recordings view."
},
"keepBridgePhoneConnected": {
"type": [
"boolean",
"null"
],
"description": "Whether to keep the user's bridge phone connected in-between outbound calls."
},
"lastName": {
"type": [
"string",
"null"
],
"description": "The last name of the user.",
"maxLength": 255
},
"lastSignInAt": {
"type": [
"string",
"null"
],
"description": "The date and time the user previously signed in.",
"format": "date-time"
},
"locked": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user is locked out of the application."
},
"mailboxErrorEmailEnabled": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user's mailbox error emails are enabled."
},
"meetingEngagementNotificationEnabled": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user's meeting engagement notifications are enabled."
},
"name": {
"type": [
"string",
"null"
],
"description": "The full name of the user."
},
"notificationsEnabled": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user's notifications are enabled."
},
"oceClickToDialEverywhere": {
"type": [
"boolean",
"null"
],
"description": "A boolean value indicating if phone calls will launch a call from Outreach (Salesforce, Github, Gmail, LinkedIn, and Twitter)."
},
"oceGmailToolbar": {
"type": [
"boolean",
"null"
],
"description": "A boolean value indicating whether the Outreach Gmail toolbar is enabled."
},
"oceGmailTrackingState": {
"type": [
"string",
"null"
],
"description": "The user's current email tracking settings when using Outreach Everywhere with GMail.",
"maxLength": 255
},
"oceSalesforceEmailDecorating": {
"type": [
"boolean",
"null"
],
"description": "A boolean value indicating if emails are enabled in Outreach Everywhere with Salesforce."
},
"oceSalesforcePhoneDecorating": {
"type": [
"boolean",
"null"
],
"description": "A boolean value indicating if phone calls are enabled in Outreach Everywhere with Salesforce."
},
"oceUniversalTaskFlow": {
"type": [
"boolean",
"null"
],
"description": "A boolean value indicating whether Outreach Everywhere universal task flow is enabled."
},
"oceWindowMode": {
"type": [
"boolean",
"null"
],
"description": "A boolean value indicating whether Outreach Everywhere window mode is enabled."
},
"opportunitiesViewId": {
"type": [
"integer",
"null"
],
"description": "The default smart view to load on the opportunity index view."
},
"passwordExpiresAt": {
"type": [
"string",
"null"
],
"description": "The date and time the current password expires.",
"format": "date-time"
},
"phoneCountryCode": {
"type": [
"string",
"null"
],
"description": "The country code of the user's phone.",
"maxLength": 2
},
"phoneNumber": {
"type": [
"string",
"null"
],
"description": "The telephone number of the user's phone."
},
"phoneType": {
"type": [
"string",
"null"
],
"description": "The user's type of telephone for outbound calls. Must be either \"bridge\" or \"voip\".",
"maxLength": 255
},
"pluginAlertNotificationEnabled": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user's plugin related error notifications are enabled."
},
"preferredVoiceRegion": {
"type": [
"string",
"null"
],
"description": "A string that represents Twilio data center used to connect to Twilio.",
"maxLength": 255
},
"prefersLocalPresence": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user prefers that a voice call comes from a local phone number."
},
"prospectsViewId": {
"type": [
"integer",
"null"
],
"description": "The default smart view to load on the prospect index view."
},
"reportsTeamPerfViewId": {
"type": [
"integer",
"null"
],
"description": "The default smart view to load on the team performance reports view."
},
"reportsViewId": {
"type": [
"integer",
"null"
],
"description": "The default smart view to load on the reports view."
},
"scimExternalId": {
"type": [
"string",
"null"
],
"description": "The ID from the SCIM provisioning service used to create the user.",
"maxLength": 255
},
"scimSource": {
"type": [
"string",
"null"
],
"description": "The name of the SCIM provisioning source used to create the user.",
"maxLength": 255
},
"senderNotificationsExcluded": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user's sender notifications are excluded."
},
"tasksViewId": {
"type": [
"integer",
"null"
],
"description": "The default smart view to load on the tasks index view."
},
"teamsViewId": {
"type": [
"integer",
"null"
],
"description": "The default smart view to load on the teams index view."
},
"textingEmailNotifications": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether to send the user email notifications when a text message is missed."
},
"title": {
"type": [
"string",
"null"
],
"description": "The user's job title (e.g. \"Staff Accountant\").",
"maxLength": 255
},
"unknownReplyEmailEnabled": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user's unknown reply emails are enabled."
},
"updatedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the user was last updated.",
"format": "date-time"
},
"userGuid": {
"type": [
"string",
"null"
],
"description": "The globally unique ID (GUID) assigned to the user."
},
"username": {
"type": [
"string",
"null"
],
"description": "A reader friendly unique identifier of the user.",
"maxLength": 255
},
"usersViewId": {
"type": [
"integer",
"null"
],
"description": "The default smart view to load on the users index view."
},
"voicemailNotificationEnabled": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user's voicemail notifications are enabled."
},
"weeklyDigestEmailEnabled": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the user's weekly digest email are enabled."
}
},
"additionalProperties": false
},
"id": {
"type": "integer"
},
"relationships": {
"type": "object",
"properties": {
"batches": {
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"calendar": {
"description": "The calendar associated with the user.",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"calendar"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"contentCategories": {
"description": "The groupings of sequences, snippets and templates that this user has access to. Relationship contentCategories cannot be used as a filter.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"contentCategory"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"contentCategoryOwnerships": {
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"contentCategoryOwnership"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"creator": {
"description": "The creator of the user. Relationship creator cannot be used as a filter.",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"user"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"directAssignedTeams": {
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"team"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"favorites": {
"description": "The user favorited by the user.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"favorite"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"jobRole": {
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"jobRole"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"mailbox": {
"description": "The default mailbox associated with the user. Relationship mailbox cannot be used as a filter.",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"mailbox"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"mailboxes": {
"description": "All mailboxes associated with the user. Relationship mailboxes cannot be used as a filter.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"mailbox"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"outboundVoicemails": {
"description": "The list of outbound voicemails associated with the user.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"outboundVoicemail"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"phone": {
"description": "The default phone to use outbound or inbound voice calls.",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"phone"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"phones": {
"description": "The list of phones associated with the user.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"phone"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"profile": {
"description": "The user's profile in Outreach. You can use only the attribute id to filter users by profile (e.g. filter[profile][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"profile"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"recipients": {
"description": "Recipients that will be included by default in all emails composed by user. Relationship recipients cannot be used as a filter.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"recipient"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"role": {
"description": "The role associated with the user. You can use only the attribute id to filter users by role (e.g. filter[role][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"role"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"roleAssignedTeams": {
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"team"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"smsPhone": {
"description": "The default phone to use for SMS messaging.",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"phone"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"teams": {
"description": "The teams the user belongs to. You can use only the attribute id to filter users by teams (e.g. filter[teams][id]=X).",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"team"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"updater": {
"description": "The most recent updater of the user. Relationship updater cannot be used as a filter.",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"user"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"voicemailPrompts": {
"description": "The list of voicemail prompts associated with the user.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"voicemailPrompt"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute outreach_list_users --payload '{}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.