> ## 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 mailings. Outreach Outreach List Mailings 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_mailings:{}' --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.provideDataConnections` | `boolean` | No | | Request resource data-connection 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 Mailings", "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." }, "provideDataConnections": { "type": "boolean", "description": "Request resource data-connection 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" } ] }, "bouncedAt": { "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 } ] }, "bouncedAt[gte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "bouncedAt[lte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "clickedAt": { "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 } ] }, "clickedAt[gte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "clickedAt[lte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "deliveredAt": { "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 } ] }, "deliveredAt[gte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "deliveredAt[lte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "mailingType": { "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 } ] }, "mailingType[gte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "mailingType[lte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "messageId": { "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 } ] }, "messageId[gte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "messageId[lte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "notifyThreadScheduledAt": { "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 } ] }, "notifyThreadScheduledAt[gte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "notifyThreadScheduledAt[lte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "notifyThreadStatus": { "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 } ] }, "notifyThreadStatus[gte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "notifyThreadStatus[lte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "openedAt": { "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 } ] }, "openedAt[gte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "openedAt[lte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "repliedAt": { "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 } ] }, "repliedAt[gte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "repliedAt[lte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "retryAt": { "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 } ] }, "retryAt[gte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "retryAt[lte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "scheduledAt": { "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 } ] }, "scheduledAt[gte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "scheduledAt[lte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "state": { "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 } ] }, "state[gte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "state[lte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "stateChangedAt": { "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 } ] }, "stateChangedAt[gte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "stateChangedAt[lte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "unsubscribedAt": { "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 } ] }, "unsubscribedAt[gte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "unsubscribedAt[lte]": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "followUpSequence[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 } ] }, "mailbox[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 } ] }, "opportunity[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 } ] }, "prospect[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 } ] }, "sequence[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 } ] }, "sequenceState[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 } ] }, "sequenceStep[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 } ] }, "task[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 } ] }, "template[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 } ] }, "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 a platform-related email.", "properties": { "bodyHtml": { "type": [ "string", "null" ], "description": "The mailing's custom email body, represented in HTML. If provided this field will override any associated template." }, "bodyText": { "type": [ "string", "null" ], "description": "The plain-text representation of the 'bodyHTML' field." }, "bouncedAt": { "type": [ "string", "null" ], "description": "The date and time the email was bounced.", "format": "date-time" }, "clickCount": { "type": [ "integer", "null" ], "description": "The total number of times links within the email were clicked (if the message is tracking links)." }, "clickedAt": { "type": [ "string", "null" ], "description": "The most recent date and time a link was clicked (if the message is tracking links).", "format": "date-time" }, "createdAt": { "type": [ "string", "null" ], "description": "The date and time the mailing was created.", "format": "date-time" }, "deliveredAt": { "type": [ "string", "null" ], "description": "The date and time the email was delivered.", "format": "date-time" }, "errorBacktrace": { "type": [ "string", "null" ], "description": "Technical details explaining the mailing's error." }, "errorReason": { "type": [ "string", "null" ], "description": "A summary explaining the mailing's error.", "maxLength": 255 }, "followUpTaskScheduledAt": { "type": [ "string", "null" ], "description": "The date and time of when a follow-up task should be due for this mailing.", "format": "date-time" }, "followUpTaskType": { "type": [ "string", "null" ], "description": "The type of follow-up task to create. Possible values are 'follow_up' or 'no_reply'.", "maxLength": 255 }, "mailboxAddress": { "type": [ "string", "null" ], "description": "The email address the mailing was sent from." }, "mailingType": { "type": [ "string", "null" ], "description": "A description of the type of the emailing (e.g. \"sequence\", \"single\", \"campaign\").", "maxLength": 255 }, "markedAsSpamAt": { "type": [ "string", "null" ], "description": "The date and time the email was marked as spam.", "format": "date-time" }, "messageId": { "type": [ "string", "null" ], "description": "The MIME content Message-ID of the delivered message.", "maxLength": 255 }, "notifyThreadCondition": { "type": [ "string", "null" ], "description": "The condition of when to bump this mailing to the top of the user's inbox. Possible values are 'always' or 'no_reply'.", "maxLength": 255 }, "notifyThreadScheduledAt": { "type": [ "string", "null" ], "description": "The date and time of when this mailing should be bumped to the top of the user's inbox.", "format": "date-time" }, "notifyThreadStatus": { "type": [ "string", "null" ], "description": "The status of the bump. Possible values are 'pending', 'sent' or 'skipped'.", "maxLength": 255 }, "openCount": { "type": [ "integer", "null" ], "description": "The total number of times the email was opened (if the message is tracking opens)." }, "openedAt": { "type": [ "string", "null" ], "description": "The most recent date and time the email was opened (if the message is tracking opens).", "format": "date-time" }, "overrideSafetySettings": { "type": [ "boolean", "null" ], "description": "A boolean value whether users can override submission if template variables have not all been replaced." }, "references": { "type": [ "array", "null" ], "description": "A list of references for the mailing taken from the email header.", "items": { "type": "string" } }, "repliedAt": { "type": [ "string", "null" ], "description": "The date and time the email was replied to.", "format": "date-time" }, "retryAt": { "type": [ "string", "null" ], "description": "The date and time the email will rety to send.", "format": "date-time" }, "retryCount": { "type": [ "integer", "null" ], "description": "The number of times the email has been retried to send." }, "retryInterval": { "type": [ "integer", "null" ], "description": "The amount of time in seconds between retry attempts." }, "scheduledAt": { "type": [ "string", "null" ], "description": "The date and time the email is scheduled to send.", "format": "date-time" }, "state": { "type": [ "string", "null" ], "description": "The current state of the mailing. Can be 'bounced', 'delivered', 'delivering', 'drafted', 'failed', 'opened', 'placeholder', 'queued', 'replied', or 'scheduled'.", "maxLength": 255 }, "stateChangedAt": { "type": [ "string", "null" ], "description": "The date and time the state last changed.", "format": "date-time" }, "subject": { "type": [ "string", "null" ], "description": "The subject line of the email." }, "trackLinks": { "type": [ "boolean", "null" ], "description": "A boolean value whether the mailing is tracking link clicks." }, "trackOpens": { "type": [ "boolean", "null" ], "description": "A boolean value whether the mailing is tracking email opens." }, "unsubscribedAt": { "type": [ "string", "null" ], "description": "The date and time the recepient unsubscribed from the mailing's sequence.", "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "description": "The date and time the mailing was last updated.", "format": "date-time" } }, "additionalProperties": false }, "id": { "type": "integer" }, "relationships": { "type": "object", "properties": { "attachments": { "description": "All attachments attached to this mailing.", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "attachment" ] } }, "additionalProperties": false } }, "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "additionalProperties": false }, "bccEntitiesId": {}, "calendar": { "description": "The calendar associated with any event invites contained in this mailing.", "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 }, "ccEntitiesId": {}, "followUpSequence": { "description": "The followup sequence associated with this mailing. You can use only the attribute id to filter mailings by followUpSequence (e.g. filter[followUpSequence][id]=X).", "properties": { "data": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "sequence" ] } }, "additionalProperties": false }, "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "additionalProperties": false }, "mailbox": { "description": "The mailbox associated with this mailing. You can use only the attribute id to filter mailings by mailbox (e.g. filter[mailbox][id]=X).", "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 }, "opportunity": { "description": "The associated opportunity. You can use only the attribute id to filter mailings by opportunity (e.g. filter[opportunity][id]=X).", "properties": { "data": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "opportunity" ] } }, "additionalProperties": false }, "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "additionalProperties": false }, "prospect": { "description": "The prospect associated with this mailing. You can use only the attribute id to filter mailings by prospect (e.g. filter[prospect][id]=X).", "properties": { "data": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "prospect" ] } }, "additionalProperties": false }, "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "additionalProperties": false }, "prospectsIds": {}, "recipients": { "description": "Recipients of the mailing. 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 }, "schedule": { "properties": { "data": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "schedule" ] } }, "additionalProperties": false }, "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "additionalProperties": false }, "sequence": { "description": "The associated sequence. You can use only the attribute id to filter mailings by sequence (e.g. filter[sequence][id]=X).", "properties": { "data": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "sequence" ] } }, "additionalProperties": false }, "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "additionalProperties": false }, "sequenceState": { "description": "The associated sequence state. You can use only the attribute id to filter mailings by sequenceState (e.g. filter[sequenceState][id]=X).", "properties": { "data": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "sequenceState" ] } }, "additionalProperties": false }, "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "additionalProperties": false }, "sequenceStep": { "description": "The associated sequence step. You can use only the attribute id to filter mailings by sequenceStep (e.g. filter[sequenceStep][id]=X).", "properties": { "data": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "sequenceStep" ] } }, "additionalProperties": false }, "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "additionalProperties": false }, "task": { "description": "The task this mailing will or did complete upon sending. You can use only the attribute id to filter mailings by task (e.g. filter[task][id]=X).", "properties": { "data": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "task" ] } }, "additionalProperties": false }, "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "additionalProperties": false }, "tasks": { "description": "All tasks associated with this mailing, such as a follow-up task. Relationship tasks cannot be used as a filter.", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "task" ] } }, "additionalProperties": false } }, "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "additionalProperties": false }, "template": { "description": "The template associated with this mailing. You can use only the attribute id to filter mailings by template (e.g. filter[template][id]=X).", "properties": { "data": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "template" ] } }, "additionalProperties": false }, "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "additionalProperties": false }, "toEntitiesId": {}, "user": { "description": "The user associated with this mailing. You can use only the attribute id to filter mailings 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_mailings --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`.