/v1/quick-messagesbetaList quick messages
- Needs
- Read your data
(mcp:read) - Plan
- Any plan with API access
- Limits
- 300 a minute per key
- Undo
- Nothing to undo: this only reads.
Lists the quick messages (saved replies your team inserts in the inbox by typing /code) this key's user can see. Favourites first, then newest.
Try it
Query (6)
Code contains this text.
Only this message type.
`true` = favourites only.
Leave out template and flow quick messages that cannot be sent on this channel.
The `next_cursor` from the previous page. Cursors expire after 24 hours.
How many items per page (1–100).
This only reads. It uses your real data and changes nothing.
Code and response
curl -X GET 'https://mcp.wa-api.cloud/v1/quick-messages' \ -H "Authorization: Bearer $API_KEY"
The code reads your key from $API_KEY.
Parameters
| Field | Type | What it is |
|---|---|---|
| search | string · query | Code contains this text.0–100 characters |
| type | string · query | Only this message type.one of: TEXT, IMAGE, VIDEO, DOCUMENT, AUDIO, TEMPLATE, INTERACTIVE, LOCATION |
| favorites_only | boolean · query | true = favourites only. |
| channel_id | string · query | Leave out template and flow quick messages that cannot be sent on this channel.0–64 charactersSigned in? Pick one from your data with “My data”. |
| cursor | string · query | The next_cursor from the previous page. Cursors expire after 24 hours.1–2048 characters |
| limit | integer · query | How many items per page (1–100).1–100 · default 25 |
Headers
| Field | Type | What it is |
|---|---|---|
| Authorizationrequired | header | Bearer $API_KEY — your API key. |
| Api-Version | header | The API version to use, e.g. 2026-10-01. Default: the version your key is pinned to.one of: 2026-10-01 · pattern ^\d{4}-\d{2}-\d{2}$ |
Response 200
A page of quick messages.
| Field | Type | What it is |
|---|---|---|
| datarequired | array of object | |
| idrequired | string | |
| coderequired | string or null | Shortcut agents type after "/" in the inbox. |
| titlerequired | string or null | |
| typerequired | string or null | TEXT, IMAGE, VIDEO, DOCUMENT, TEMPLATE, INTERACTIVE … |
| textrequired | string or null | Text body, or the media caption. |
| media_urlrequired | string or null | |
| template_namerequired | string or null | |
| visibilityrequired | string or null | |
| team_idrequired | string or null | |
| favoriterequired | boolean | |
| can_editrequired | boolean | |
| updated_atrequired | string or null | |
| totalrequired | number | |
| next_cursorrequired | string or null | Pass as "cursor" to get the next page; null when there are no more results. |
Errors
Errors are application/problem+json. Branch on code.
| Status | Code | When |
|---|---|---|
| 400 | invalid_input | A field is missing or has the wrong format. |
| 401 | unauthenticated | The Authorization header is missing, the key is unknown, expired or revoked. |
| 403 | entitlement_required | The workspace's plan does not include API access ( |
| 403 | insufficient_scope | The key does not have the permission this operation needs. |
| 429 | rate_limited | The key or workspace went over its rate limit. Wait for |
| 503 | upstream_unavailable | A service behind the API is briefly unavailable. Safe to retry with backoff. |
Examples
All quick messages
Response 200
{
"data": [
{
"id": "12",
"code": "thanks",
"title": "Thank you",
"type": "TEXT",
"text": "Thanks for your order, {{contact.name}}!",
"media_url": null,
"template_name": null,
"visibility": "company",
"team_id": null,
"favorite": true,
"can_edit": true,
"updated_at": "2026-09-02T10:00:00Z"
}
],
"next_cursor": null,
"total": 1
}Operation path
The same operation is also at POST /v1/ops/messaging_list_quick_messages, with every field in the JSON body.