> ## 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 the steps that make up Outreach sequences. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.
## 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_sequence_steps:{}' --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.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 Sequence Steps",
"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."
},
"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].",
"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 descriptor of a single step within an automated sequence.",
"properties": {
"bounceCount": {
"type": [
"integer",
"null"
],
"description": "The total count of bounced mailings during this sequence step."
},
"clickCount": {
"type": [
"integer",
"null"
],
"description": "The total count of clicked mailings from this sequence step."
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "The date and time the sequence step was created.",
"format": "date-time"
},
"date": {
"type": [
"string",
"null"
],
"description": "The date this step will activate; only applicable to date-based sequences.",
"format": "date"
},
"deliverCount": {
"type": [
"integer",
"null"
],
"description": "The total count of delivered mailings from this sequence step."
},
"displayName": {
"type": [
"string",
"null"
],
"description": "A human-readable display name that captures the step’s type and order."
},
"failureCount": {
"type": [
"integer",
"null"
],
"description": "The total count of failed mailings from this sequence step."
},
"interval": {
"type": [
"integer",
"null"
],
"description": "The interval (in seconds) until this step will activate; only applicable to interval-based sequences."
},
"negativeReplyCount": {
"type": [
"integer",
"null"
],
"description": "The total count of negative reply mailings from this sequence step."
},
"neutralReplyCount": {
"type": [
"integer",
"null"
],
"description": "The total count of neutral reply mailings from this sequence step."
},
"openCount": {
"type": [
"integer",
"null"
],
"description": "The total count of opened mailings from this sequence step."
},
"optOutCount": {
"type": [
"integer",
"null"
],
"description": "The total count of opted out mailings from this sequence step."
},
"order": {
"type": [
"integer",
"null"
],
"description": "The step’s display order within its sequence."
},
"positiveReplyCount": {
"type": [
"integer",
"null"
],
"description": "The total count of positive reply mailings from this sequence step."
},
"replyCount": {
"type": [
"integer",
"null"
],
"description": "The total count of replied mailings from this sequence step."
},
"scheduleCount": {
"type": [
"integer",
"null"
],
"description": "The total count of scheduled mailings from this sequence step."
},
"stepType": {
"type": [
"string",
"null"
],
"description": "The step’s type; must be \"auto_email\", \"manual_email\", \"call\" or \"task\".",
"maxLength": 255
},
"taskAutoskipDelay": {
"type": [
"integer",
"null"
],
"description": "The optional interval (in seconds) from when tasks created by this sequence step are overdue until they are automatically skipped."
},
"taskNote": {
"type": [
"string",
"null"
],
"description": "An optional note to associate with created tasks.",
"maxLength": 65535
},
"updatedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the sequence step was last updated.",
"format": "date-time"
}
},
"additionalProperties": false
},
"id": {
"type": "integer"
},
"relationships": {
"type": "object",
"properties": {
"callPurpose": {
"description": "The default call purpose associated with the sequence step. You can use only the attribute id to filter sequenceSteps by callPurpose (e.g. filter[callPurpose][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"callPurpose"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"calls": {
"description": "The calls associated with the sequence step. You can use only the attribute id to filter sequenceSteps by calls (e.g. filter[calls][id]=X).",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"creator": {
"description": "The creator of the sequence step. You can use only the attribute id to filter sequenceSteps by creator (e.g. filter[creator][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
},
"mailings": {
"description": "The mailings associated with the sequence step. Relationship mailings cannot be used as a filter.",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"schedule": {
"description": "The associated 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 attributes id, enabledAt and name to filter sequenceSteps 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
},
"sequenceTemplates": {
"description": "The sequence templates in use by this sequence step. You can use any filterable attribute of sequenceTemplates.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"sequenceTemplate"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"taskPriority": {
"description": "The associated task priority. You can use only the attribute id to filter sequenceSteps by taskPriority (e.g. filter[taskPriority][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"taskPriority"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"tasks": {
"description": "The tasks associated with the sequence step. You can use only the attribute id to filter sequenceSteps by tasks (e.g. filter[tasks][id]=X).",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"updater": {
"description": "The most recent updater of the sequence step. You can use only the attribute id to filter sequenceSteps by updater (e.g. filter[updater][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_sequence_steps --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`.