> ## 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

> Read a prospect stage by ID. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=outreach_get_stage:{"id":"{{id}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name              | Type      | Required | Default | Description                                                                  |
| ----------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------- |
| `payload.id`      | `integer` | Yes      |         |                                                                              |
| `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]. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Get a Stage by ID",
    "properties": {
      "id": {
        "type": "integer"
      },
      "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
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "attributes": {
                "type": "object",
                "description": "A descriptor of the point in the process, used for categorizing Prospects.",
                "properties": {
                  "color": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The color the stage label will be highlighted in the interface, specified as a hexidecimal value (e.g. \"#5951ff\").",
                    "maxLength": 255
                  },
                  "createdAt": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The date and time the stage was created.",
                    "format": "date-time"
                  },
                  "name": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The name of the stage (e.g. \"Qualified Lead\").",
                    "maxLength": 255
                  },
                  "order": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "description": "The stage's display order within the collection."
                  },
                  "updatedAt": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The date and time the stage was last updated.",
                    "format": "date-time"
                  }
                },
                "additionalProperties": false
              },
              "id": {
                "type": "integer"
              },
              "relationships": {
                "type": "object",
                "properties": {
                  "creator": {
                    "description": "The creator of the stage. 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
                  },
                  "prospects": {
                    "description": "The prospects associated to the stage. You can use only the attribute id to filter stages by prospects (e.g. filter[prospects][id]=X).",
                    "properties": {
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "updater": {
                    "description": "The most recent updater of the stage. 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
                  }
                },
                "additionalProperties": false
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute outreach_get_stage --payload '{
  "id": "integer"
}' --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`.