---
title: "Get Template"
method: GET
path: "/accounts/{{account_id}}/templates/{template_id}"
tags: ["Templates"]
---

# Get Template

`GET /accounts/{{account_id}}/templates/{template_id}`

## Request

- Base URL: `https://experiences.api.brightcove.com/v1`
- URL: `https://experiences.api.brightcove.com/v1/accounts/{{account_id}}/templates/{template_id}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://oauth.brightcove.com/v4/access_token` scopes: `video-cloud/experience/read`

Gets the specified template

## Query parameters

- `locale` 'en_US' | 'es_ES' | 'fr_FR' | 'ja_JP' | 'ko_KO' | 'zh_HANT'
- `version` string

## Response `200`

SUCCESS

- Template: In-Page Experience template
  - `id` string: ID of the template
  - `version` string: Template version
  - `metadata` TemplateMetadata: Metadata describing the template
    - `name` string: Template display name
    - `description` string: Template description
    - `demo` string: URL to a demo of the template
    - `image` string: Relative URL to an SVG image representing the template
    - `views` TemplateView[]
      - `name` string: View ID
      - `title` string: View display name
      - `isPlaybackView` boolean: Whether this view is used for playing back videos
      - `hidden` boolean: Whether this view is hidden in the authoring environment
    - `layouts` TemplateLayout[]
      - `name` string: Layout ID
      - `title` string: Layout display name
      - `categories` TemplateLayoutCategory[]
        - `name` string: Template layout category ID
        - `title` string: Template layout category display name
        - `options` TemplateLayoutOption[]
          - `name` string: Template layout option ID
          - `title` string: Template layout option display name
          - `image` string: Relative URL to an SVG image which represents the layout option
    - `options` TemplateOptions: Template options
      - `singleVideo` boolean: Whether this template only displays a single video
      - `liveVideo` boolean: Whether this template displays a live video

## Other responses

- `400`: BAD_REQUEST: The template version must be a semantic version string (i.e. `1.0.0`)
- `401`: UNAUTHORIZED: Authentication failed - check to make sure your client credentials were correct for the access token
- `404`: NOT_FOUND: The specified template does not exist

## Changes

- **2023-03-26** `4ba1a5bb9017`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/brightcovelearning/apis/brightcove-in-page-experiences-api-reference/changes/accounts/:{account_id}/templates/:template_id/get.md)

---

[API](https://skmtc.dev/brightcovelearning/apis/brightcove-in-page-experiences-api-reference.md) - [All operations](https://skmtc.dev/brightcovelearning/apis/brightcove-in-page-experiences-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/brightcovelearning/apis/brightcove-in-page-experiences-api-reference/revisions/4ba1a5bb9017?raw)