---
title: "Get canned message"
method: GET
path: "/api/v4/messaging/canned_messages/{canned_message_id}"
tags: ["Messaging"]
---

# Get canned message

`GET /api/v4/messaging/canned_messages/{canned_message_id}`

## Request

- Base URL: `https://{cluster_id}.voiso.com`
- URL: `https://{cluster_id}.voiso.com/api/v4/messaging/canned_messages/{canned_message_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/voiso/apis/voiso-api/docs/api/v4/messaging/canned_messages/:canned_message_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns detailed information about a specific canned message.

## Path parameters

- `canned_message_id` integer, required

## Response `200`

OK

- object
  - `canned_message` CannedMessage: Canned response template for messaging channels.
    - `id` integer: The unique identifier of the canned message.
    - `name` string: The name of the canned message.
    - `body` string: Message body with optional placeholders.
    - `channels` string[]: Channels where this canned message can be used.
    - `teams` TeamShort[]: Teams that can use this canned message.
      - `id` integer: The unique identifier of the team.
      - `name` string: The name of the team.
    - `created_at` string, date-time: Timestamp when the canned message was created (ISO 8601).
    - `updated_at` string, date-time: Timestamp when the canned message was last updated (ISO 8601).

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `429`: Too many requests

---

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