---
title: "Get list of canned messages"
method: GET
path: "/api/v4/messaging/canned_messages"
tags: ["Messaging"]
---

# Get list of canned messages

`GET /api/v4/messaging/canned_messages`

## Request

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

Returns a paginated list of all canned messages.

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

OK

- object
  - `canned_messages` CannedMessage[]
    - `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).
  - `metadata` Metadata: Pagination metadata for list responses.
    - `total` integer: The total number of items available for the requested resource.
    - `next_cursor` string, nullable: Cursor for fetching the next page of results when cursor-based pagination is supported.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too many requests

## Changes

- **2026-11-03** `5a6ea146bd21`: 1 breaking
  - for the `query` request parameter `limit`, the max was decreased from `1000.00` to `100.00`

[Operation history](https://skmtc.dev/voiso/apis/voiso-api/changes/api/v4/messaging/canned_messages/get.md)

---

[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)