List Active Macros

GET {{baseUrl}}/api/v2/macros/active?include=<string>&access=<string>&category=<integer>&group_id=<integer>&sort_by=<string>&sort_order=<string>

Lists all active shared and personal macros available to the current user.

Allowed For

Agents

Request Params

Key	Datatype	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"
`category`	string	Filter macros by category
`group_id`	string	Filter macros by group
`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

HEADERS

Key	Datatype	Required	Description
`Accept`	string

RESPONSES

status: OK

{&quot;count&quot;:2,&quot;macros&quot;:[{&quot;actions&quot;:[],&quot;active&quot;:true,&quot;description&quot;:&quot;Sets the ticket status to `solved`&quot;,&quot;id&quot;:25,&quot;position&quot;:42,&quot;restriction&quot;:{},&quot;title&quot;:&quot;Close and Save&quot;},{&quot;actions&quot;:[],&quot;active&quot;:false,&quot;description&quot;:&quot;Adds a `priority` tag to the ticket&quot;,&quot;id&quot;:26,&quot;restriction&quot;:{},&quot;title&quot;:&quot;Assign priority tag&quot;}],&quot;next_page&quot;:null,&quot;previous_page&quot;:null}