---
title: "/chat/templates-message"
method: GET
path: "/chat/templates-message"
tags: ["Chat"]
---

# /chat/templates-message

`GET /chat/templates-message`

## Request

- Base URL: `<<api-url>>` (relative, and the document’s source URL is not known)
- URL: `<<api-url>>/chat/templates-message`
- Auth: API key in header `X-API-KEY`

Retrieve all templates message

## Query parameters

- `filters` Filters[]
  - `property` string, required: Name of the property
  - `operator` 'eq' | 'ne' | 'lt' | 'gt' | 'le' | 'ge' | 'in' | 'nin', required: Comparison operator
  - `value` union, required: Name of the property
    - string
    - number
    - boolean
- `page` number
- `limit` number

## Headers

- `octa-agent-email` string

## Response `201`

- TemplateMessageResponse[]
  - `id` string: Template ID
  - `name` string: Template name
  - `status` string: Template status
  - `category` string: Template category
  - `createdBy` string: Created by
  - `createdAt` string, date-time: Created at
  - `components` Component[]: Template components
    - `message` string: Message that will be sent
    - `type` string: Type of component
    - `variables` Variable[]: Variables sent in the message
      - `type` string: Variable type
      - `key` string: Variable key
      - `example` object: Example of value
      - `metadata` object: Variable metadata
    - `buttons` Button[]: Buttons that will be displayed
      - `label` string: Button label
      - `type` string: Button type
      - `value` string: Button value
  - `enable` boolean: If template is enabled

---

[API](https://skmtc.dev/octadesk/apis/octadesk-api.md) - [All operations](https://skmtc.dev/octadesk/apis/octadesk-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octadesk/apis/octadesk-api/revisions/cf3224b37a34?raw)
