> ## 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 mailboxes. Outreach Outreach List Mailboxes 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_mailboxes:{}' --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 Mailboxes",
"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"
}
]
},
"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"
}
]
},
"userId": {
"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
}
]
},
"userId[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"userId[lte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"user[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": "A representation of an email mailbox, used within the application for sending and syncing emails.",
"properties": {
"authId": {
"type": [
"integer",
"null"
],
"description": "The auth id associated with the mailbox."
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "The date and time the mailbox was created.",
"format": "date-time"
},
"editable": {
"type": [
"boolean",
"null"
],
"description": "A boolean value to indicate if the user has the permission to edit mailbox fields."
},
"email": {
"type": [
"string",
"null"
],
"description": "The email address of the mailbox.",
"maxLength": 255
},
"emailHash": {
"type": [
"string",
"null"
],
"description": "Hashed email address of the mailbox.",
"maxLength": 255
},
"emailProvider": {
"type": [
"string",
"null"
],
"description": "The mail service provider. While not a required field, it is strongly recommended to use one of 'exchange_online', 'exchange_server', 'gmail', 'gmail_api', 'google_oauth2', 'intermedia', 'office365_oauth2', 'microsoft_hma_oauth2', 'office_365', 'rackspace'. If no value is provided, send and sync will make assumptions based on the ews, imap, and smtp values provided.",
"maxLength": 255
},
"emailSignature": {
"type": [
"string",
"null"
],
"description": "The default signature, in HTML, to be appended to sent email messages.",
"maxLength": 65535
},
"ewsEndpoint": {
"type": [
"string",
"null"
],
"description": "The url of the Exchange Web Service.",
"maxLength": 255
},
"ewsSslVerifyMode": {
"type": [
"integer",
"null"
],
"description": "The SSL verify mode, represented as an integer, the EWS connection will used. (verify none=0, verify peer=1, verify client once=4, verify fail if no peer cert=2)"
},
"exchangeVersion": {
"type": [
"string",
"null"
],
"description": "The version of Exchange. Must be one of 'Exchange2007', 'Exchange2007_SP1', 'Exchange2010', 'Exchange2010_SP1', 'Exchange2010_SP2', 'Exchange2013', 'Exchange2013_SP1'.",
"maxLength": 255
},
"imapHost": {
"type": [
"string",
"null"
],
"description": "The address of the IMAP host, used for syncing (e.g. 'imap.gmail.com').",
"maxLength": 255
},
"imapPort": {
"type": [
"integer",
"null"
],
"description": "The port number the IMAP server is using (e.g. '993')."
},
"imapSsl": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the IMAP connection will use SSL."
},
"maxEmailsPerDay": {
"type": [
"integer",
"null"
],
"description": "The maximum number of in/out emails per day."
},
"maxMailingsPerDay": {
"type": [
"integer",
"null"
],
"description": "The maximum number of emails the application can send in a day from this mailbox. Recommended value is 500."
},
"maxMailingsPerWeek": {
"type": [
"integer",
"null"
],
"description": "The maximum number of emails the application can send within a week from this mailbox. Recommended value is 5000."
},
"optOutMessage": {
"type": [
"string",
"null"
],
"description": "The message displayed on the unsubscribe confirmation page, seen after clicking the unsubscribe link in the email (e.g. \"To unsubscribe, click the button below.\").",
"maxLength": 512
},
"optOutSignature": {
"type": [
"string",
"null"
],
"description": "The message below the signature, in HTML, when the sequence requires an unsubscribe link (e.g. \"If you'd like me to stop sending you emails, please ` click here `\").",
"maxLength": 512
},
"password": {
"type": [
"string",
"null"
],
"description": "The password of the mailbox. This attribute can be used to set the password, but is not available for read.",
"maxLength": 65535
},
"prospectEmailExclusions": {
"type": [
"string",
"null"
],
"description": "A list (provided as a string, newline-delimited) of email address patterns to be excluded from syncing (e.g. \"`*@outreach.io daniel@example.com`\").",
"maxLength": 65535
},
"providerId": {
"type": [
"integer",
"null"
],
"description": "The id of the provider associated with this calendar."
},
"providerType": {
"type": [
"string",
"null"
],
"description": "Email provider type.",
"maxLength": 255
},
"sendDisabled": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether sending is disabled from this mailbox."
},
"sendErroredAt": {
"type": [
"string",
"null"
],
"description": "The date and time the most recent send error occurred.",
"format": "date-time"
},
"sendMaxRetries": {
"type": [
"integer",
"null"
],
"description": "The maximum number of times to auto-retry a delivery when it fails."
},
"sendMethod": {
"type": [
"string",
"null"
],
"description": "The method used for sending email. Must be either 'ews', 'sendgrid', or 'smtp'.",
"maxLength": 255
},
"sendPeriod": {
"type": [
"integer",
"null"
],
"description": "The amount of time in seconds that the number of sendThreshold emails can be sent. Recommended value is two deliveries per minute (sendPeriod is 60)."
},
"sendRequiresSync": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the mailbox is required to be recently synced before sending."
},
"sendSuccessAt": {
"type": [
"string",
"null"
],
"description": "The date and time the most recent successful email send occurred.",
"format": "date-time"
},
"sendThreshold": {
"type": [
"integer",
"null"
],
"description": "The maximum number of email sends per the sendPeriod amount of time. Recommended value is two deliveries per minute (sendThreshold is 2)."
},
"sendgridApiKey": {
"type": [
"string",
"null"
],
"description": "The api key of the SendGrid account used for sending.",
"maxLength": 65535
},
"sendgridWebhookUrl": {
"type": [
"string",
"null"
],
"description": "The endpoint required within the SendGrid account settings to support bounce and spam-report tracking."
},
"smtpHost": {
"type": [
"string",
"null"
],
"description": "The address of the SMTP host, used for sending (e.g. 'smtp.gmail.com').",
"maxLength": 255
},
"smtpPassword": {
"type": [
"string",
"null"
],
"description": "The password for the SMTP account. This value should be left blank unless a separate SMTP account is being used for sending (i.e. not the mailbox's main username/password).",
"maxLength": 65535
},
"smtpPort": {
"type": [
"integer",
"null"
],
"description": "The port number the SMTP server is using (e.g. '587')."
},
"smtpSsl": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the SMTP connection will use SSL."
},
"smtpUsername": {
"type": [
"string",
"null"
],
"description": "The username for the SMTP account. This value should be left blank unless a separate SMTP account is being used for sending (i.e. not the mailbox's main username/password).",
"maxLength": 255
},
"syncActiveFrequency": {
"type": [
"integer",
"null"
],
"description": "The amount of time in seconds between syncing when the user is actively using the application."
},
"syncDisabled": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether syncing is disabled from this mailbox."
},
"syncErroredAt": {
"type": [
"string",
"null"
],
"description": "The date and time the most recent sync error occurred.",
"format": "date-time"
},
"syncFinishedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the most recent sync finished.",
"format": "date-time"
},
"syncMethod": {
"type": [
"string",
"null"
],
"description": "The method used for syncing email. Must be either 'ews', 'gmail_api', or 'imap'.",
"maxLength": 255
},
"syncOutreachFolder": {
"type": [
"boolean",
"null"
],
"description": "A boolean value whether the folder for syncing is named 'Outreach' instead of 'Inbox'. Only available for Exchange version 'Exchange2007_SP1'."
},
"syncPassiveFrequency": {
"type": [
"integer",
"null"
],
"description": "The amount of time in seconds between syncing when the user is not actively using the application."
},
"syncSuccessAt": {
"type": [
"string",
"null"
],
"description": "The date and time the most recent successful email sync occurred.",
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the mailbox was last updated.",
"format": "date-time"
},
"userId": {
"type": [
"integer",
"null"
],
"description": "The id of the user associated with this mailbox."
},
"username": {
"type": [
"string",
"null"
],
"description": "The username of the email account. While not a required field, a username is necessary for most email providers outside of OAuth. This value is normally the same as the email address.",
"maxLength": 255
},
"validateSend": {
"type": [
"boolean",
"null"
],
"description": "If this is set to true then the record will only save successfully if the mailbox is properly configured to send emails."
},
"validateSync": {
"type": [
"boolean",
"null"
],
"description": "If this is set to true then the record will only save successfully if the mailbox is properly configured to sync emails."
}
},
"additionalProperties": false
},
"id": {
"type": "integer"
},
"relationships": {
"type": "object",
"properties": {
"creator": {
"description": "The creator of the mailbox. 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
},
"mailAliases": {
"description": "The email aliases associated with this mailbox Relationship mailAliases cannot be used as a filter.",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"mailings": {
"description": "The mailings sent via this mailbox. Relationship mailings cannot be used as a filter.",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"updater": {
"description": "The most recent updater of the mailbox. 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
},
"user": {
"description": "The user owning this mailbox. You can use only the attribute id to filter mailboxes by user (e.g. filter[user][id]=X).",
"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
}
},
"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_mailboxes --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`.