Skip to main content

List Support Macros

GET 
/api/support/admin/macros

Lists every macro (canned reply) — shared and private alike — for administration. Agents see only shared macros plus their own through the agent endpoints.

Required scope: support:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Query parameters

  • filter[search] (string, optional) — partial match on the name, the shortcut, or the plain-text body.
  • filter[is_shared] (boolean, optional) — true for shared macros only, false for private ones only.
  • filter[updated_at] (date, optional) — a single day (2026-09-08) or an inclusive range as from,to (2026-09-01,2026-09-30), matched by calendar day.
  • sort (string, optional) — prefix with - for descending. Allowed sorts: name, shortcut, updated_at. Default: name ascending.
  • per_page (integer, optional) — items per page. Default 10, maximum 100.
  • page (integer, optional) — page number. Default 1.

Response fields: id (integer), name (string), shortcut (string, nullable), body_html (string), body_text (string), actions (object, nullable — status, priority, type, group_key, add_tags[]), is_shared (boolean), created_by (object, nullable — id, name), is_mine (boolean — whether the caller authored the macro), created_at / updated_at (ISO-8601).

Pagination: standard Laravel pagination envelope (current_page, data, last_page, per_page, total, ...).

Authentication: Bearer token with the support:read scope, or an authenticated session, from a caller with an active support role who also holds the support admin role. No tenant context — this endpoint is central.

Request​

Responses​

OK

Response Headers
    Content-Type