---
title: "Get message templates"
method: GET
path: "/api/ext/v3/messageTemplates"
tags: ["MessageTemplate"]
---

# Get message templates

`GET /api/ext/v3/messageTemplates`

## Query parameters

- `channel` string
- `page_number` integer, required
- `page_size` integer, required

## Response `200`

Returns the message templates.

- GetMessageTemplatesResponse — Response model for getting message templates.
  - `templates` MessageTemplateDto[], nullable — The list of message templates.
    - `id` string, nullable — The unique identifier of the message template.
    - `name` string, nullable — The name of the message template.
    - `category` string, nullable — The category of the template.
    - `sub_category` string, nullable — The subcategory of the template.
    - `catalog_info` CatalogInfoDto — Represents catalog information for a message template.
      - `catalog_id` string, nullable — The catalog identifier.
      - `thumbnail_product` CatalogProductDto — Represents a catalog product.
        - `product_retailer_id` string, nullable — The product retailer identifier.
        - `id` string, nullable — The product identifier.
        - `retailer_product_group_id` string, nullable — The retailer product group identifier.
        - `price` string, nullable — The product price.
        - `sale_price` string, nullable — The sale price.
        - `name` string, nullable — The product name.
        - `currency` string, nullable — The currency.
        - `image_url` string, nullable — The image URL.
        - `errors` ProductErrorDto[], nullable — The list of product errors.
          - `title` string, nullable — The error title.
          - `type` string, nullable — The error type.
      - `is_active` boolean — Whether the catalog is active.
    - `hsm` string, nullable — The HSM (Highly Structured Message) content.
    - `hsm_original` string, nullable — The original HSM content.
    - `custom_params` TemplateParameterDto[], nullable — The list of custom parameters associated with this template.
      - `name` string, nullable — The name of the template parameter.
      - `value` string, nullable — The value of the template parameter.
    - `status` string, nullable — The current status of the template.
    - `language_option` LanguageOptionDto — Represents a language option for a message template.
      - `key` string, nullable — The language key identifier.
      - `value` string, nullable — The language value.
      - `text` string, nullable — The display text for the language option.
    - `last_modified` string, date-time — The last modification date of the template.
    - `type` string, nullable — The type of the message template.
    - `header` HeaderMessageTemplateComponentDto — Represents a header component for a message template.
      - `type` string, nullable — The type of header component.
      - `text` string, nullable — The text content of the header.
      - `link` string, nullable — The link associated with the header.
      - `media_header_id` string, nullable — The media header identifier.
      - `media_from_pc` string, nullable — The media from PC identifier.
      - `header_original` string, nullable — The original header content.
      - `header_param_mapping` TemplateParamDto — Represents a template parameter.
        - `index` integer — The parameter index.
        - `param_name` string, nullable — The parameter name.
    - `body` string, nullable — The body content of the template.
    - `body_original` string, nullable — The original body content of the template.
    - `footer` string, nullable — The footer content of the template.
    - `buttons` ButtonMessageTemplateComponentDto[], nullable — The list of button components.
      - `type` string, nullable — The type of button component.
      - `parameter` ButtonMessageTemplateComponentParameterDto — Represents parameters for a button component.
        - `text` string, nullable — The button text.
        - `phone_number` string, nullable — The phone number for call buttons.
        - `url` string, nullable — The URL for URL buttons.
        - `url_original` string, nullable — The original URL content.
        - `url_type` string, nullable — The type of URL.
        - `button_param_mapping` TemplateParamDto — Represents a template parameter.
          - `index` integer — The parameter index.
          - `param_name` string, nullable — The parameter name.
        - `copy_offer_code` string, nullable — The copy offer code.
        - `order_details` OrderDetailsParametersDto — Represents order details parameters.
          - `reference_id` string, nullable — The reference identifier.
          - `type` string, nullable — The parameter type.
          - `payment_configuration` string, nullable — The payment configuration.
          - `currency` string, nullable — The currency.
          - `total_amount` string, nullable — The total amount.
          - `order` string, nullable — The order details.
          - `payment_type` string, nullable — The payment type.
          - `beneficiaries` string, nullable — The list of beneficiaries.
          - `payment_settings` string, nullable — The payment settings.
          - `shipping_info` string, nullable — The shipping information.
    - `buttons_type` string, nullable — The type of buttons used in the template.
    - `carousel_cards` CarouselMessageTemplateViewModelDto[], nullable — The list of carousel cards for the template.
      - `header` HeaderMessageTemplateComponentDto — Represents a header component for a message template.
        - `type` string, nullable — The type of header component.
        - `text` string, nullable — The text content of the header.
        - `link` string, nullable — The link associated with the header.
        - `media_header_id` string, nullable — The media header identifier.
        - `media_from_pc` string, nullable — The media from PC identifier.
        - `header_original` string, nullable — The original header content.
        - `header_param_mapping` TemplateParamDto — Represents a template parameter.
          - `index` integer — The parameter index.
          - `param_name` string, nullable — The parameter name.
      - `body` string, nullable — The body content.
      - `body_original` string, nullable — The original body content.
      - `body_param_mapping` TemplateParamDto[], nullable — The body parameter mapping.
        - `index` integer — The parameter index.
        - `param_name` string, nullable — The parameter name.
      - `buttons` ButtonMessageTemplateComponentDto[], nullable — The list of buttons.
        - `type` string, nullable — The type of button component.
        - `parameter` ButtonMessageTemplateComponentParameterDto — Represents parameters for a button component.
          - `text` string, nullable — The button text.
          - `phone_number` string, nullable — The phone number for call buttons.
          - `url` string, nullable — The URL for URL buttons.
          - `url_original` string, nullable — The original URL content.
          - `url_type` string, nullable — The type of URL.
          - `button_param_mapping` TemplateParamDto — Represents a template parameter.
            - `index` integer — The parameter index.
            - `param_name` string, nullable — The parameter name.
          - `copy_offer_code` string, nullable — The copy offer code.
          - `order_details` OrderDetailsParametersDto — Represents order details parameters.
            - `reference_id` string, nullable — The reference identifier.
            - `type` string, nullable — The parameter type.
            - `payment_configuration` string, nullable — The payment configuration.
            - `currency` string, nullable — The currency.
            - `total_amount` string, nullable — The total amount.
            - `order` string, nullable — The order details.
            - `payment_type` string, nullable — The payment type.
            - `beneficiaries` string, nullable — The list of beneficiaries.
            - `payment_settings` string, nullable — The payment settings.
            - `shipping_info` string, nullable — The shipping information.
      - `buttons_type` string, nullable — The type of buttons.
    - `expires_in` integer — Expiration time in seconds.
    - `include_expiry_time` boolean — Whether to include expiry time.
    - `add_security_recommendation` boolean — Whether to add security recommendation.
    - `is_url_btn_click_tracking_enabled` boolean — Whether URL button click tracking is enabled.
    - `limited_time_offer` LimitedTimeOfferDto — Represents a limited time offer configuration for a message template.
      - `text` string, nullable — The offer text description.
      - `has_expiration` boolean — Whether the offer has an expiration time.
      - `expiration_time` string, date-time — The expiration date and time of the offer.
    - `quality` string, nullable — The quality rating of the template.
    - `creation_method` string, nullable — The method used to create the template.
  - `page_number` integer — The current page number.
  - `page_size` integer — The number of items per page.
  - `total` integer — The total number of message templates available.

## Other responses

- `400` — The request is invalid.
- `401` — The request is unauthorized.
- `403` — The request is forbidden.
- `429` — Too many requests. Either the rate limit has been exceeded or usage limits have been reached.
- `500` — Unexpected error occurred. Please try again.

---

[API](https://skmtc.dev/wati/apis/api-documentation-v3.md) · [All operations](https://skmtc.dev/wati/apis/api-documentation-v3/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/wati/api-documentation-v3/revisions/dee16d2c7d41/schema)
