---
schema_version: "1"
id: 847b3e20b8b97c52dbc78b0ab8bd53c1ef0b25f17bed3f68938b900a8ffe0003
title: Get Template
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/industries/cme/guides/comms-get-template.md
canonical_url: https://developer.salesforce.com/docs/industries/cme/guide/comms-get-template.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 5bb2fc41dce3b9a52aa8cf8e77d73103f2364588d26a38f82a277ba65262c511
products:
  - Communications, Media, Energy and Utilities APIs (Managed Package)
  - Industries Developer Documentation
---
# Get Template

Retrieves a specific Sales Configuration Template by its ID, including metadata, associated tags, and cart totals.

## Resource Information

- **Resource URL:** `/services/apexrest/<namespace>/v1/cpq/templates/{templateId}`
- **HTTP Method:** GET
- **Content-Type:** application/json
- **Response Format:** JSON

## Request Body

| Parameter  | Type   | Required | Description                             |
| ---------- | ------ | -------- | --------------------------------------- |
| templateId | String | Yes      | The SalesConfigTemplate\_\_c record ID. |

## Example REST Request

`GET /services/apexrest/vlocity_cmt/v1/cpq/templates/a1Bxx0000004XyzDEF`

## Response Parameters

| Parameter                     | Type    | Description                                                                             |
| ----------------------------- | ------- | --------------------------------------------------------------------------------------- |
| Id                            | String  | Template record ID.                                                                     |
| Name                          | String  | Template name.                                                                          |
| Description\_\_c              | String  | Template description.                                                                   |
| Status\_\_c                   | String  | Current lifecycle status.                                                               |
| Category\_\_c                 | String  | Template category.                                                                      |
| TemplateQuoteId\_\_c          | String  | ID of the underlying template Quote (if Quote-based).                                   |
| TemplateOrderId\_\_c          | String  | ID of the underlying template Order (if Order-based).                                   |
| CartType                      | String  | Either "Quote" or "Order", indicating the type of the underlying cart.                  |
| Tags                          | Array   | List of associated tag objects, each containing Id, Name, and Description\_\_c.         |
| EffectiveOneTimeTotal\_\_c    | Decimal | Total effective one-time charges from the template cart.                                |
| EffectiveRecurringTotal\_\_c  | Decimal | Total effective recurring charges from the template cart.                               |
| EffectiveUsagePriceTotal\_\_c | Decimal | Total effective usage charges (only present when the Usage Pricing feature is enabled). |
| PriceList\_\_r                | Object  | Related Price List with Id, Name, and CurrencyCode\_\_c.                                |

## Example REST Response

Success Response (200):

```
{
  "success": true,
  "errorCode": "INVOKE-200",
  "result": {
    "messages": [],
    "templateDetails": {
      "template": {
        "Id": "a1Bxx0000004XyzDEF",
        "Name": "Enterprise Fiber Bundle",
        "vlocity_cmt__Description__c": "Standard fiber bundle for enterprise customers",
        "vlocity_cmt__Status__c": "Approved",
        "vlocity_cmt__Category__c": "Enterprise",
        "vlocity_cmt__TemplateQuoteId__c": "0Q0xx0000004CabCAE",
        "CartType": "Quote",
        "Tags": [
          {
            "Id": "a2Cxx0000001AbcDEF",
            "Name": "Enterprise",
            "vlocity_cmt__Description__c": "Templates for enterprise customers"
          },
          {
            "Id": "a2Cxx0000001DefGHI",
            "Name": "Fiber",
            "vlocity_cmt__Description__c": null
          }
        ],
        "vlocity_cmt__EffectiveOneTimeTotal__c": 299.99,
        "vlocity_cmt__EffectiveRecurringTotal__c": 89.99,
        "vlocity_cmt__EffectiveUsagePriceTotal__c": 0.00,
        "vlocity_cmt__PriceList__r": {
          "Id": "a3Dxx0000002GhiJKL",
          "Name": "Standard Price List",
          "vlocity_cmt__CurrencyCode__c": "USD"
        }
      }
    }
  }
}

```