List macros

get

https://{domain}.gorgias.com/api/macros

Query Params

tags

languages

array of strings or null

languages

cursor

string

Value indicating your position in the list of all tags. If omitted, the first tags of the list will be returned.

limit

integer

1 to 100

Defaults to 30

Maximum number of tags to return.

message_id

integer | null

Defaults to null

Order macros by the most relevant ones to reply to the given message. When specified, order_by must be set to relevance and ticket_id is required.

order_by

string

enum

Defaults to usage

Order macros by the given attribute. If relevance is specified, ticket_id parameter is required and macros will be ordered by the most relevant macros to reply to the given ticket. In this case, order_dir parameter will be ignored.
Values <span style={{color: 'red'}}>name, created_datetime, update_datetime, usage, relevance have been deprecated. Use values with :asc or :desc instead.

string | null

Defaults to null

Filter macros containing the given search query.

ticket_id

integer | null

Defaults to null

Order macros by the most relevant ones to reply to the given ticket. When specified, order_by must be set to relevance.

number_predictions

integer

Defaults to 0

Number of relevant macros to return on top of the list.

archived

boolean | null

Defaults to false

Filter macros that are archived. If True, only archived macros will be returned.

Response

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of macros.