List Macros
gorgias_list_macrosList and filter helpdesk macros by search query, tags, languages, archived status, or ticket relevance. Supports cursor-based pagination.
Instructions
GET /api/macros — List all macros with optional filtering by search query, tags, languages, archived status, and relevance to a ticket. Supports cursor-based pagination.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | Filter macros containing all tags in the given list | |
| limit | No | Max number of macros to return per page (default: 30, max: 100) | |
| cursor | No | Pagination cursor from a previous response | |
| search | No | Filter macros containing the given search query | |
| archived | No | Filter by archived status. If true, only archived macros are returned. Defaults to false. | |
| order_by | No | Sort order for macros. When using relevance sorting, ticket_id is required. | |
| languages | No | Filter macros containing any language in the given list (ISO 639-1 codes) | |
| ticket_id | No | Order macros by the most relevant ones to reply to the given ticket. Required when order_by is 'relevance'. | |
| message_id | No | Order macros by the most relevant ones to reply to the given message. Requires order_by='relevance' and ticket_id. | |
| number_predictions | No | Number of relevant macros to return on top of the list (default: 0) |