younifyd
Menu

List Macros

List macros

GET/api/macros

Use it in a workflow

  1. Add a step and choose the Gorgias connector.
  2. Pick the List Macros action (under Macros).
  3. Fill in the fields below, then reference the result from later steps as {{listMacros.response.data}}.

Request

Query parameters

tagsarray<string | null>
languagesarray<string | null>
cursorstring

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

limitinteger

Maximum number of tags to return.

Default 30

message_idinteger | 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.

Default null

order_bystring

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.<br>Values <span style={{color: 'red'}}>`name`, `created_datetime`, `update_datetime`, `usage`, `relevance` have been deprecated</span>. Use values with `:asc` or `:desc` instead.

One ofnamecreated_datetimeupdated_datetimeusagerelevancelanguagename:ascname:desccreated_datetime:asccreated_datetime:descupdated_datetime:ascupdated_datetime:descusage:ascusage:descrelevance:ascrelevance:desclanguage:asclanguage:descDefault "usage"

searchstring | null

Filter macros containing the given search query.

Default null

ticket_idinteger | null

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

Default null

number_predictionsinteger

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

Default 0

archivedboolean | null

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

Default false

Response

Returns 200 with a array<object>. Read it in later steps with {{listMacros.response.data.<field>}}.

Need more? See the Gorgias guide for connection setup and behaviour shared by every action.

Was this page helpful?