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

> Read an Outreach email template by ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Read an Outreach email template by ID.

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

## 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_template',
  {
    "id": 123
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute outreach_get_template --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": {
        "archived": false,
        "archivedAt": "2026-01-15T12:00:00Z",
        "bccRecipients": [
          "example"
        ]
      },
      "id": 123,
      "relationships": {
        "attachments": {
          "links": {}
        },
        "contentCategoryMemberships": {
          "links": {}
        },
        "creator": {
          "data": {},
          "links": {}
        }
      }
    }
  }
}
```

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

## Input reference

Get a Template 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 a Template 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 | — | A reusable template for building emails. |
| `result.data.data.attributes.archived` | `boolean \| null` | No | — | Boolean value indicating if the template has been archived. |
| `result.data.data.attributes.archivedAt` | `string \| null` | No | — | The date and time the template was archived. Format: `date-time`. |
| `result.data.data.attributes.bccRecipients` | `array \| null` | No | — | A list of default person and email address pairs to receive this template in the "bcc" field (e.g. \[Billy Bob ` `]) |
| `result.data.data.attributes.bodyHtml` | `string \| null` | No | — | The body HTML of the template. Maximum length: 16777215. |
| `result.data.data.attributes.bodyText` | `string \| null` | No | — | The body text of the template. Maximum length: 16777215. |
| `result.data.data.attributes.bounceCount` | `integer \| null` | No | — | The total count of bounced mailings during this template. |
| `result.data.data.attributes.ccRecipients` | `array \| null` | No | — | A list of default person and email address pairs to receive this template in the "cc" field (e.g. \[Billy Bob ` `]) |
| `result.data.data.attributes.clickCount` | `integer \| null` | No | — | The total count of clicked mailings from this template. |
| `result.data.data.attributes.createdAt` | `string \| null` | No | — | The date and time the template was created. Format: `date-time`. |
| `result.data.data.attributes.deliverCount` | `integer \| null` | No | — | The total count of delivered mailings from this template. |
| `result.data.data.attributes.failureCount` | `integer \| null` | No | — | The total count of failed mailings from this template. |
| `result.data.data.attributes.lastUsedAt` | `string \| null` | No | — | The last time the template was used. Format: `date-time`. |
| `result.data.data.attributes.name` | `string \| null` | No | — | The name of the template. Maximum length: 225. |
| `result.data.data.attributes.negativeReplyCount` | `integer \| null` | No | — | The total count of negative reply mailings from this template. |
| `result.data.data.attributes.neutralReplyCount` | `integer \| null` | No | — | The total count of neutral reply mailings from this template. |
| `result.data.data.attributes.openCount` | `integer \| null` | No | — | The total count of opened mailings from this template. |
| `result.data.data.attributes.optOutCount` | `integer \| null` | No | — | The total count of opted out mailings from this template. |
| `result.data.data.attributes.positiveReplyCount` | `integer \| null` | No | — | The total count of positive reply mailings from this template. |
| `result.data.data.attributes.replyCount` | `integer \| null` | No | — | The total count of replied mailings from this template. |
| `result.data.data.attributes.scheduleCount` | `integer \| null` | No | — | The total count of scheduled mailings from this template. |
| `result.data.data.attributes.shareType` | `string \| null` | No | — | The share type must be one of "read\_only," "private," or "shared". Maximum length: 255. |
| `result.data.data.attributes.subject` | `string \| null` | No | — | The subject line for the email to be sent. |
| `result.data.data.attributes.tags` | `array \| null` | No | — | A list of tag values associated with the template (e.g. \["Sequencing", "Quick Response"]). |
| `result.data.data.attributes.toRecipients` | `array \| null` | No | — | A list of default person and email address pairs to receive this template in the "to" field (e.g. \["Billy Bob "]) |
| `result.data.data.attributes.trackLinks` | `boolean \| null` | No | — | Boolean value indicating if link tracking is on for the template. |
| `result.data.data.attributes.trackOpens` | `boolean \| null` | No | — | Boolean value indicating if open tracking is on for the template. |
| `result.data.data.attributes.updatedAt` | `string \| null` | No | — | The date and time the template was last updated. Format: `date-time`. |
| `result.data.data.id` | `integer` | No | — | — |
| `result.data.data.relationships` | `object` | No | — | — |
| `result.data.data.relationships.attachments` | `object` | No | — | The attachments to be sent with this template. |
| `result.data.data.relationships.attachments.data` | `array` | No | — | — |
| `result.data.data.relationships.attachments.data[].id` | `integer` | No | — | — |
| `result.data.data.relationships.attachments.data[].type` | `"attachment"` | No | — | Allowed: `attachment`. |
| `result.data.data.relationships.attachments.links` | `object` | No | — | — |
| `result.data.data.relationships.attachments.links.related` | `string` | No | — | Format: `uri`. |
| `result.data.data.relationships.contentCategoryMemberships` | `object` | No | — | The content cateogories with which this template is associated. Relationship contentCategoryMemberships cannot be used as a filter. |
| `result.data.data.relationships.contentCategoryMemberships.data` | `array` | No | — | — |
| `result.data.data.relationships.contentCategoryMemberships.data[].id` | `integer` | No | — | — |
| `result.data.data.relationships.contentCategoryMemberships.data[].type` | `"contentCategoryMembership"` | No | — | Allowed: `contentCategoryMembership`. |
| `result.data.data.relationships.contentCategoryMemberships.links` | `object` | No | — | — |
| `result.data.data.relationships.contentCategoryMemberships.links.related` | `string` | No | — | Format: `uri`. |
| `result.data.data.relationships.creator` | `object` | No | — | The creator of the template. You can use only the attribute id to filter templates by creator (e.g. filter\[creator]\[id]=X). |
| `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`. |

The table shows the first 50 fields. Expand the raw schema below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe outreach_get_template --json`.

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