> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Re:amaze

> Re:amaze is a multi-channel customer support platform offering live chat, email, social messaging, and automated workflows.

![Re:amaze logo](https://mintcdn.com/composio-preview/HvfZXDijhFOaKyF5/images/toolkits/re_amaze.svg?fit=max\&auto=format\&n=HvfZXDijhFOaKyF5\&q=85\&s=175d3016198f9360c4f4adab113089f8)

* **Category:** customer support
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 9
* **Triggers:** 0
* **Slug:** `RE_AMAZE`
* **Version:** 20261021\_00

## Tools

> [accordion] Get Contact by Email
>
> **Slug:** `RE_AMAZE_GET_CONTACT_BY_EMAIL`
>
> Retrieve a Re:amaze contact by an exact email-address match.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Exact contact email address to look up.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Conversation
>
> **Slug:** `RE_AMAZE_GET_CONVERSATION`
>
> Retrieve one Re:amaze conversation by its supported identifier.
>
> #### Input Parameters
>
> **channel** `string`
>
> Optional channel type used with id\_type origin
>
> **id\_type** `string ("ref" | "origin")`
>
> How to interpret conversation\_id; omit for slug lookup with database-ID fallback
>
> **category** `string`
>
> Category slug; required when id\_type is origin
>
> **conversation\_id** `string` *required*
>
> Conversation slug by default; a reference ID when id\_type is ref, an origin ID when id\_type is origin, or a database ID when slug lookup fails
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get report tags
>
> **Slug:** `RE_AMAZE_GET_REPORTS_TAGS`
>
> Tool to retrieve a list of tags used in reports. Use when analyzing tag usage metrics across conversations.
>
> #### Input Parameters
>
> **end\_date** `string`
>
> Report end date in YYYY-MM-DD format
>
> **start\_date** `string`
>
> Report start date in YYYY-MM-DD format
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Response Templates
>
> **Slug:** `RE_AMAZE_GET_RESPONSE_TEMPLATES`
>
> Tool to retrieve response templates for the brand. Use when you need canned responses to streamline replies.
>
> #### Input Parameters
>
> **q** `string`
>
> Search query to filter response templates by keywords
>
> **page** `integer`
>
> Page number for pagination through results
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Staff Performance Report
>
> **Slug:** `RE_AMAZE_GET_STAFF_PERFORMANCE_REPORT`
>
> Retrieve staff performance metrics for a Re:amaze report period.
>
> #### Input Parameters
>
> **brand** `string`
>
> Brand URL to filter; omit to include all account brands.
>
> **end\_date** `string`
>
> Report end date in YYYY-MM-DD format.
>
> **start\_date** `string`
>
> Report start date in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Articles
>
> **Slug:** `RE_AMAZE_LIST_ARTICLES`
>
> List and search Re:amaze Help Center articles.
>
> #### Input Parameters
>
> **page** `integer`
>
> One-based results page.
>
> **query** `string`
>
> Keyword query used to search articles.
>
> **status** `string ("published" | "draft" | "internal")`
>
> Article visibility status to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Contact Identities
>
> **Slug:** `RE_AMAZE_LIST_CONTACT_IDENTITIES`
>
> Retrieve the identities linked to a Re:amaze contact email.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address of the contact whose identities to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Conversations
>
> **Slug:** `RE_AMAZE_LIST_CONVERSATIONS`
>
> Lists Re:amaze conversations with optional status, order, and date filters.
>
> #### Input Parameters
>
> **tag** `string`
>
> Comma-separated tags that matching conversations must have
>
> **data** `object`
>
> Conversation data key-value pairs to match
>
> **page** `integer`
>
> One-based results page
>
> **sort** `string ("updated" | "changed")`
>
> Sort by latest customer update or latest change; omit to sort by creation time
>
> **filter** `string ("archived" | "open" | "unassigned" | "all")`
>
> Conversation status group; omit to return unarchived conversations
>
> **for\_id** `string`
>
> Return conversations relevant to this customer SSO ID
>
> **origin** `string`
>
> Conversation origin code or name to match
>
> **category** `string`
>
> Channel category slug to match
>
> **end\_date** `string`
>
> ISO 8601 upper bound for latest customer message time
>
> **for\_email** `string`
>
> Return conversations relevant to this user email
>
> **start\_date** `string`
>
> ISO 8601 lower bound for latest customer message time
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Messages
>
> **Slug:** `RE_AMAZE_LIST_MESSAGES`
>
> List messages across a Re:amaze brand or within one conversation.
>
> #### Input Parameters
>
> **tag** `string`
>
> Comma-separated conversation tags to match
>
> **page** `integer`
>
> One-based results page
>
> **filter** `string ("staff" | "customer")`
>
> Return only staff or customer messages
>
> **origin** `integer`
>
> Numeric message origin code to match
>
> **include** `string`
>
> Include each message's original HTML body
>
> **sent\_by** `string`
>
> Known user email that sent the messages
>
> **category** `string`
>
> Channel category slug to match
>
> **end\_date** `string`
>
> ISO 8601 upper bound for message creation time
>
> **start\_date** `string`
>
> ISO 8601 lower bound for message creation time
>
> **conversation\_slug** `string`
>
> Conversation slug to scope results; omit for all brand messages
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
