GET /api/v2/macros/search
Pagination
- Offset pagination only
See Using Offset Pagination.
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 |
query |
String | Yes |
Query string used to find macros with matching titles |
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", or "position". 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.