GET/macros

List macros

Lists macros (saved replies) in the workspace, ordered by most recently updated. Use starting_after to continue from the previous page and updated_since to filter by update time. The starting_after cursor is a Base64-encoded JSON array containing the previous page's last updated_at and id values.

4 parameters
per_pageintegeroptional
The number of macros to return per page. Must be between 1 and 150. Defaults to 50 when omitted.
Default:50
starting_afterstringoptional
A Base64-encoded cursor containing the `updated_at` and `id` values of the last item on the previous page.
updated_sinceintegeroptional
A Unix timestamp; return only macros updated after this time.
Intercom-Versionstringoptional
The Intercom API version to use. Supported versions include the listed values; defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

4 status codes
200Returns a paginated list of macro objects and pagination information, including the page size and next cursor.
typestringoptional
Always list
Allowed:list
dataarray<Macro>optional
The list of macro objects
pagesobjectoptional
Pagination information
400Returned when a query value is invalid.

One documented failure

  • parameter_invalid

    Invalid updated_since timestamp

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
403Returned when the request lacks the required OAuth scope.

One documented failure

  • forbidden

    You do not have the required scope (read_conversations) to access this resource

    OAuth token lacks read_conversations scope

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 400 is returned when a query value is invalid. A 401 is returned when the request is unauthorized, and a 403 is returned when the request lacks the required OAuth scope. per_page must be between 1 and 150; starting_after must be a Base64-encoded cursor containing [updated_at, id], and updated_since is a Unix timestamp.