---
title: "getTemplateStructure"
slug: "ai-application-service-cloudoutboundmailer-gettemplatestructure"
updated: 2026-09-17T09:57:20Z
published: 2026-09-17T09:57:20Z
canonical: "api.ncloud-docs.com/ai-application-service-cloudoutboundmailer-gettemplatestructure"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# getTemplateStructure

Classic/VPC環境で利用できます。

メールテンプレートとカテゴリ構造を照会します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET | /template |

### リクエストヘッダ

Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、[Cloud Outbound Mailerのリクエストヘッダ](/docs/ja/ai-application-service-cloudoutboundmailer#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `isUse` | Boolean | Optional | 使用中のテンプレートとカテゴリ構造のみを照会するかどうか - `true` \| `false` - `true`: 使用中のテンプレートとカテゴリのみ照会 - `false`: 使用していないテンプレートとカテゴリも一緒に照会 |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/template?isUse=true' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `contents` | List | - | 照会対象テンプレートとカテゴリの詳細構造 - [TemplateStructureResponse](/docs/ja/common-vapidatatype-nestemplatestructurecontent)を参照 |

### レスポンスステータスコード

Cloud Outbound Mailer APIで共通して使用されるレスポンスステータスコードの詳細は、[Cloud Outbound Mailerのレスポンスステータスコード](/docs/ja/ai-application-service-cloudoutboundmailer#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
  "contents": [
    {
      "sid": 261,
      "parentSid": -1,
      "createDate": {
        "utc": 1589355820663,
        "formattedDate": "2020-05-13",
        "formattedDateTime": "2020-05-13 16:43:40 663"
      },
      "name": "AD",
      "isCategory": true,
      "isUse": true,
      "subCategories": null,
      "templates": [
        {
          "sid": 262,
          "parentSid": 261,
          "createDate": {
            "utc": 1589355868201,
            "formattedDate": "2020-05-13",
            "formattedDateTime": "2020-05-13 16:44:28 201"
          },
          "name": "AD_Template",
          "isCategory": false,
          "isUse": true,
          "subCategories": null,
          "templates": null
        }
      ]
    }
  ]
}
```