> ## 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: Get Opportunity Stage

> Read an opportunity stage by ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Read an opportunity stage by ID.

> [!NOTE]
>
> Tool ID: `outreach_get_opportunity_stage`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'outreach_get_opportunity_stage',
  {
    "id": 123
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute outreach_get_opportunity_stage --input '{
  "id": 123
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "data": {
      "attributes": {
        "color": "example",
        "createdAt": "2026-01-15T12:00:00Z",
        "isClosed": true
      },
      "id": 123,
      "relationships": {
        "creator": {
          "data": {},
          "links": {}
        },
        "opportunities": {
          "links": {}
        }
      }
    }
  }
}
```

Use `deepline describe outreach_get_opportunity_stage --json` for the latest machine-readable contract.

## Input reference

Get an Opportunity Stage by ID

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `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={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get an Opportunity 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 reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `object` | No | — | — |
| `result.data.data.attributes` | `object` | No | — | The stage an opportunity is in. Requires the Opportunities SKU to be enabled in order to have access. Please contact support for more assistance. |
| `result.data.data.attributes.color` | `string \| null` | No | — | The color used to label and highlight the opportunity stage. Maximum length: 255. |
| `result.data.data.attributes.createdAt` | `string \| null` | No | — | The date and time the opportunity stage was created. Format: `date-time`. |
| `result.data.data.attributes.isClosed` | `boolean \| null` | No | — | Either true or flase, whether or not the opportunity stage represents an open or closed state of an opportunity. |
| `result.data.data.attributes.name` | `string \| null` | No | — | The name of the opportunity stage. Maximum length: 255. |
| `result.data.data.attributes.order` | `integer \| null` | No | — | The order of the opportunity stage. |
| `result.data.data.attributes.updatedAt` | `string \| null` | No | — | The date and time the opportunity stage was last updated. Format: `date-time`. |
| `result.data.data.id` | `integer` | No | — | — |
| `result.data.data.relationships` | `object` | No | — | — |
| `result.data.data.relationships.creator` | `object` | No | — | The creator of the opportunity. Relationship creator cannot be used as a filter. |
| `result.data.data.relationships.creator.data` | `object \| null` | No | — | — |
| `result.data.data.relationships.creator.data.id` | `integer` | No | — | — |
| `result.data.data.relationships.creator.data.type` | `"user"` | No | — | Allowed: `user`. |
| `result.data.data.relationships.creator.links` | `object` | No | — | — |
| `result.data.data.relationships.creator.links.related` | `string` | No | — | Format: `uri`. |
| `result.data.data.relationships.opportunities` | `object` | No | — | The opportunities currently associated with the opportunity stage. Relationship opportunities cannot be used as a filter. |
| `result.data.data.relationships.opportunities.links` | `object` | No | — | — |
| `result.data.data.relationships.opportunities.links.related` | `string` | No | — | Format: `uri`. |
| `result.data.data.type` | `string` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "attributes": {
                "type": "object",
                "description": "The stage an opportunity is in. Requires the Opportunities SKU to be enabled in order to have access. Please contact support for more assistance.",
                "properties": {
                  "color": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The color used to label and highlight the opportunity stage.",
                    "maxLength": 255
                  },
                  "createdAt": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The date and time the opportunity stage was created.",
                    "format": "date-time"
                  },
                  "isClosed": {
                    "type": [
                      "boolean",
                      "null"
                    ],
                    "description": "Either true or flase, whether or not the opportunity stage represents an open or closed state of an opportunity."
                  },
                  "name": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The name of the opportunity stage.",
                    "maxLength": 255
                  },
                  "order": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "description": "The order of the opportunity stage."
                  },
                  "updatedAt": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The date and time the opportunity stage was last updated.",
                    "format": "date-time"
                  }
                },
                "additionalProperties": false
              },
              "id": {
                "type": "integer"
              },
              "relationships": {
                "type": "object",
                "properties": {
                  "creator": {
                    "description": "The creator of the opportunity. 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
                  },
                  "opportunities": {
                    "description": "The opportunities currently associated with the opportunity stage. Relationship opportunities cannot be used as a filter.",
                    "properties": {
                      "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>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Outreach provider guide](https://deepline.com/docs/providers/outreach/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.