v29

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-13511526891.2 KB
Macros

List Active Macros

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

Allowed For

  • Agents
get/api/v2/macros/active

Query parameters

includestring

A sideload to include in the response. See Sideloads

accessstring

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.

categoryinteger

Filter macros by category

group_idinteger

Filter macros by group

sort_bystring

Possible values are "alphabetical", "created_at", "updated_at", "usage_1h", "usage_24h", "usage_7d", or "usage_30d". Defaults to alphabetical

sort_orderstring

One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others

Response

Success Response

countinteger

the total record count

next_pagestring url nullable

the URL of the next page

previous_pagestring url nullable

the URL of the previous page