---
title: "View template"
method: GET
path: "/templates/{template_id}?app_id={app_id}"
---

# View template

`GET /templates/{template_id}?app_id={app_id}`

Retrieve the details of a specific message template in your OneSignal app using its template ID. This API returns the template content, target channel, and timestamps for creation and last update.

## Path parameters

- `template_id` string, required

## Query parameters

- `app_id` string, required

## Headers

- `Authorization` string, required
- `Content-Type` string, required

## Response `200`

200

- union
  - object
    - `id` string — The template ID in UUID v4 format.
    - `name` string — An internal name you set to help organize and track Templates. Maximum 128 characters.
    - `channel` string — Options are: `push`, `email`, and `SMS`.
    - `created_at` string — The date and time the template was created in ISO 8601 format.
    - `updated_at` string — The date and time the template was last updated in ISO 8601 format.
    - `content` object — The template content.
      - `isAndroid` boolean — Template enabled for Android.
      - `isIos` boolean — Template enabled for iOS.
      - `isMacOSX` boolean — Template enabled for macOS.
      - `isAdm` boolean — Template enabled for Amazon.
      - `isWP_WNS` boolean — Template enabled for Windows.
      - `isChromeWeb` boolean — Template enabled for Chrome Web.
      - `isSafari` boolean — Template enabled for Safari.
      - `isFirefox` boolean — Template enabled for Firefox.
      - `isEdge` boolean — Template enabled for Edge.
      - `headings` object
        - `en` string — The push message title in each set language type. See [Supported Languages](/docs/en/multi-language-messaging#supported-languages).
      - `contents` object — The main message body with [language-specific values](/docs/en/multi-language-messaging#supported-languages). Supports [Personalization](/docs/en/message-personalization).
        - `en` string, required — The required message language type. See [Supported Languages](/docs/en/multi-language-messaging#supported-languages).
      - `global_image` unknown
      - `url` string
      - `isEmail` boolean — Required to be set `true` for email templates.
      - `email_body` string — The body of the email in HTML format. Required if `template_id` is not set. Supports [Message Personalization](/docs/message-personalization).
      - `email_subject` string — The subject of the email. Supports [Message Personalization](/docs/message-personalization).
      - `email_preheader` unknown
      - `email_from_address` string — The full email address shown in the 'From' field of the email (e.g., `promotions@news.example.com`). This is what recipients see as the sender. If not specified, OneSignal uses the default 'Sender Email' set in your Dashboard's Email Settings. See [Senders](/docs/senders).
      - `email_from_name` unknown
      - `isSMS` boolean — Required to be set `true` for SMS templates.
      - `sms_from` unknown
      - `sms_media_urls` unknown
      - `email_reply_to_address` unknown
      - `disable_email_click_tracking` unknown
  - object
    - `id` string
    - `name` string
    - `created_at` string
    - `updated_at` string
    - `content` object
      - `isAndroid` unknown
      - `isIos` unknown
      - `isMacOSX` unknown
      - `isAdm` unknown
      - `isAlexa` unknown
      - `isWP` unknown
      - `isWP_WNS` unknown
      - `isChrome` unknown
      - `isChromeWeb` unknown
      - `isSafari` unknown
      - `isFirefox` unknown
      - `isEdge` unknown
      - `headings` object
      - `subtitle` unknown
      - `contents` object — The main message body with [language-specific values](/docs/en/multi-language-messaging#supported-languages). Supports [Message Personalization](/docs/message-personalization).
        - `en` string, required — The required message language type. See [Supported Languages](/docs/en/multi-language-messaging#supported-languages).
      - `global_image` unknown
      - `url` unknown
      - `isEmail` boolean — Required to be set `true` for email templates.
      - `email_body` string — The body of the email in HTML format. Required if `template_id` is not set. Supports [Message Personalization](/docs/message-personalization).
      - `email_subject` string — The subject of the email. Supports [Message Personalization](/docs/message-personalization).
      - `email_preheader` string
      - `isSMS` boolean — Required to be set `true` for SMS templates.
      - `sms_from` unknown
      - `sms_media_urls` unknown
      - `email_reply_to_address` string
      - `disable_email_click_tracking` boolean
      - `email_from_address` string
      - `email_from_name` string
      - `email_bcc` string[] — BCC recipients for the email template. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email.

## Other responses

- `400` — 400
- `404` — 404
- `429` — 429
- `503` — Service temporarily unavailable. Retry after a short backoff. The body may be empty or non-JSON in some failure modes.

---

[API](https://skmtc.net/onesignal/apis/api-onesignal-com.md) · [All operations](https://skmtc.net/onesignal/apis/api-onesignal-com/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onesignal/api-onesignal-com/revisions/0fc223f7e338/schema)