Search Macros
GET {{baseUrl}}/api/v2/macros/search?include=<string>&access=<string>&active=<boolean>&category=<integer>&group_id=<integer>&only_viewable=<boolean>&sort_by=<string>&sort_order=<string>&query=<string>
Pagination
- Offset pagination only
Allowed For
- Agents
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include | string | A sideload to include in the response. See Sideloads | |
access | string | Filter macros by access. Possible values are "personal", "shared", or "account" | |
active | string | Filter by active macros if true or inactive macros if false | |
category | string | Filter macros by category | |
group_id | string | Filter macros by group | |
only_viewable | string | If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false | |
sort_by | string | Possible values are alphabetical, "created_at", "updated_at", "usage_1h", "usage_24h", "usage_7d", or "usage_30d". Defaults to alphabetical | |
sort_order | string | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others | |
query | string | (Required) Query string used to find macros with matching titles |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"count":2,"macros":[{"actions":[],"active":true,"description":"Sets the ticket status to `solved`","id":25,"position":42,"restriction":{},"title":"Close and Save"},{"actions":[],"active":false,"description":"Adds a `priority` tag to the ticket","id":26,"restriction":{},"title":"Assign priority tag"}],"next_page":null,"previous_page":null}