List Macros
Lists all shared and personal macros available to the current user. For admins, the API returns all macros for the account, including the personal macros of agents and other admins.
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Returns a maximum of 100 records per page.
Allowed For
- Agents
Query parameters
A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.
A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.
Specifies how many records should be returned in the response. You can specify up to 100 records per page.
A sideload to include in the response. See Sideloads
Filter macros by access. Possible values are "personal", "agents", "shared", or "account". The "agents" value returns all personal macros for the account's agents and is only available to admins.
Filter by active macros if true or inactive macros if false
Filter macros by category
Filter macros by group
If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false
Possible values are "alphabetical", "created_at", "updated_at", "usage_1h", "usage_24h", "usage_7d", or "usage_30d". Defaults to alphabetical
One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others
Response
Success Response