> ## 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 prospect sequence states. 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_states:{}' --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 Sequence States",
"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"
}
]
},
"callCompletedAt": {
"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
}
]
},
"callCompletedAt[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"callCompletedAt[lte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"clickCount": {
"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
}
]
},
"clickCount[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"clickCount[lte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"deliverCount": {
"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
}
]
},
"deliverCount[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"deliverCount[lte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"openCount": {
"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
}
]
},
"openCount[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"openCount[lte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"pauseReason": {
"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
}
]
},
"pauseReason[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"pauseReason[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"
}
]
},
"replyCount": {
"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
}
]
},
"replyCount[gte]": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"replyCount[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"
}
]
},
"account[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
}
]
},
"calls[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
}
]
},
"mailbox[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
}
]
},
"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
}
]
},
"prospect[emails]": {
"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
}
]
},
"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
}
]
},
"tasks[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
}
]
},
"tasks[dueAt]": {
"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 descriptor of a currently sequenced prospect, which includes relationships to its sequence, prospect and user.",
"properties": {
"activeAt": {
"type": [
"string",
"null"
],
"description": "The date and time the sequence state was last active.",
"format": "date-time"
},
"bounceCount": {
"type": [
"integer",
"null"
],
"description": "The total count of bounced mailings during this sequence state."
},
"callCompletedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the sequence state last had a call completed.",
"format": "date-time"
},
"clickCount": {
"type": [
"integer",
"null"
],
"description": "The total count of clicked mailings from this sequence state."
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "The date and time the sequence state was created.",
"format": "date-time"
},
"deliverCount": {
"type": [
"integer",
"null"
],
"description": "The total count of delivered mailings from this sequence state."
},
"errorReason": {
"type": [
"string",
"null"
],
"description": "The reason for the most recent error.",
"maxLength": 255
},
"failureCount": {
"type": [
"integer",
"null"
],
"description": "The total count of failed mailings from this sequence state."
},
"negativeReplyCount": {
"type": [
"integer",
"null"
],
"description": "The total count of negative reply mailings from this sequence state."
},
"neutralReplyCount": {
"type": [
"integer",
"null"
],
"description": "The total count of neutral reply mailings from this sequence state."
},
"openCount": {
"type": [
"integer",
"null"
],
"description": "The total count of opened mailings from this sequence state."
},
"optOutCount": {
"type": [
"integer",
"null"
],
"description": "The total count of opted out mailings from this sequence state."
},
"pauseReason": {
"type": [
"string",
"null"
],
"description": "The reason for the most recent pause.",
"maxLength": 255
},
"positiveReplyCount": {
"type": [
"integer",
"null"
],
"description": "The total count of positive reply mailings from this sequence state."
},
"repliedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the sequence state last had a mailing reply.",
"format": "date-time"
},
"replyCount": {
"type": [
"integer",
"null"
],
"description": "The total count of replied mailings from this sequence state."
},
"scheduleCount": {
"type": [
"integer",
"null"
],
"description": "The total count of scheduled mailings from this sequence state."
},
"state": {
"type": [
"string",
"null"
],
"description": "The current state of the sequence state.",
"maxLength": 255
},
"stateChangedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the sequence state’s state last changed.",
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the sequence state was last updated.",
"format": "date-time"
}
},
"additionalProperties": false
},
"id": {
"type": "integer"
},
"relationships": {
"type": "object",
"properties": {
"account": {
"description": "The account associated with the prospect the sequence state is targeting. You can use only the attribute id to filter sequenceStates by account (e.g. filter[account][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"account"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"activeStepMailings": {
"description": "Any undelivered mailings associated with the current sequence step. Relationship activeStepMailings cannot be used as a filter.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"mailing"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"activeStepTasks": {
"description": "Any incomplete tasks associated with the current sequence step. Relationship activeStepTasks 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
},
"batchItemCreator": {
"description": "The batch item associated with this creation, if one exists.",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"batchItem"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"calls": {
"description": "The calls associated with the sequence state. You can use only the attribute id to filter sequenceStates 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 state. 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
},
"mailbox": {
"description": "The mailbox to use for mailing steps. You can use attributes id and email to filter sequenceStates 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
},
"mailings": {
"description": "The mailings associated with the sequence state. Relationship mailings cannot be used as a filter.",
"properties": {
"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 sequenceStates 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 primary prospect this sequence state is targeting. You can use attributes id and emails to filter sequenceStates 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
},
"sequence": {
"description": "The sequence this prospect is engaged in. You can use any filterable attribute of sequence.",
"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
},
"sequenceStateRecipients": {
"description": "Additional recipients associated with this sequence state.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"sequenceStateRecipient"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"sequenceStep": {
"description": "The current sequence step the prospect is in. You can use any filterable attribute of sequenceStep.",
"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
},
"tasks": {
"description": "The tasks associated with the sequence state. You can use attributes id and dueAt to filter sequenceStates by tasks (e.g. filter[tasks][id]=X).",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"user": {
"description": "The user managing this sequence state.",
"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_states --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`.