GET /api/v2/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
Servers
- https://{subdomain}.{domain}.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
category |
Integer | No |
Filter macros by category |
sort_order |
String | No |
One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others |
include |
String | No |
A sideload to include in the response. See Sideloads |
active |
Boolean | No |
Filter by active macros if true or inactive macros if false |
access |
String | No |
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. |
group_id |
Integer | No |
Filter macros by group |
sort_by |
String | No |
Possible values are "alphabetical", "created_at", "updated_at", "usage_1h", "usage_24h", "usage_7d", or "usage_30d". Defaults to alphabetical |
only_viewable |
Boolean | No |
If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.