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

# Gatherup

> GatherUp is a customer feedback and online review management platform that helps businesses collect, manage, and leverage customer feedback to improve their online reputation.

![Gatherup logo](https://mintcdn.com/composio-preview/GL28i3tBlbEbBd-f/images/toolkits/gatherup.svg?fit=max\&auto=format\&n=GL28i3tBlbEbBd-f\&q=85\&s=f7b8828d1cd4890313bc891d3c91ea7a)

* **Category:** reviews
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 9
* **Triggers:** 0
* **Slug:** `GATHERUP`
* **Version:** 20261101\_00

## Tools

> [accordion] Delete GatherUp Business
>
> **Slug:** `GATHERUP_DELETE_BUSINESS`
>
> Permanently deletes a business location from GatherUp. This is a destructive operation that cannot be undone. **When to use**: Remove business locations that are no longer needed or were created in error. **Important**: Verify the businessId before deletion. Check errorCode in response: 0=success, non-zero=error.
>
> #### Input Parameters
>
> **businessId** `integer` *required*
>
> Unique ID of the business location to delete. Obtain this from search or get business endpoints.
>
> #### 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] Find GatherUp Agency Client ID
>
> **Slug:** `GATHERUP_FIND_AGENCY_CLIENT_ID`
>
> Find the numeric agency client identifier associated with a GatherUp business location. This identifier is the agent number used to target a client in agency-level API operations, not the clientId credential.
>
> #### Input Parameters
>
> **businessId** `integer` *required*
>
> The unique ID of the business to find the client ID for. This identifies the specific business location in GatherUp.
>
> #### 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 GatherUp Business
>
> **Slug:** `GATHERUP_GET_BUSINESS`
>
> Retrieve detailed information about a specific GatherUp business location. Returns comprehensive business data including: name, contact details (phone, address), timezone, business type, subscription package, communication settings, engagement metrics (NPS score, feedback counts), and marketing assets (logos, banners, feedback URLs). Prerequisites: - Use GATHERUP\_SEARCH\_BUSINESS if you need to find a businessId by customField/extraField
>
> #### Input Parameters
>
> **businessId** `integer` *required*
>
> The unique ID of the business to retrieve. Use GATHERUP\_SEARCH\_BUSINESS to find business IDs by customField or extraField.
>
> #### 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 GatherUp Business Types
>
> **Slug:** `GATHERUP_GET_BUSINESS_TYPES`
>
> Retrieves the list of available business categories from GatherUp (e.g., Restaurant, Hotel, Dental Office). Use this to: - Get valid business type IDs for creating new businesses - Discover available business categories in GatherUp - Filter business types by search term (optional)
>
> #### Input Parameters
>
> **search** `string`
>
> Optional search term to filter business types by name (e.g., 'restaurant', 'hotel', 'cafe')
>
> #### 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 GatherUp Customer
>
> **Slug:** `GATHERUP_GET_CUSTOMER`
>
> Retrieves detailed information about a specific customer from GatherUp by their customer ID. Use this action to get customer details including name, email, phone, rating, feedback status, and other customer-related information. Common use cases: - Retrieve customer contact information before sending feedback requests - Check customer's current rating and feedback status - Verify customer subscription status (unsubscribed flag) - Get customer creation date and associated business details Error codes: 0=success, 2=invalid clientId, 3=server error, 44=customer not found Endpoint: POST [https://app.gatherup.com/api/customer/get](https://app.gatherup.com/api/customer/get)
>
> #### Input Parameters
>
> **customerId** `integer` *required*
>
> The unique ID of the customer to retrieve. This is the internal customer identifier assigned by GatherUp when the customer was created.
>
> #### 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 Widget HTML
>
> **Slug:** `GATHERUP_GET_WIDGET_HTML`
>
> Retrieve pre-formatted widget or badge HTML code with schema.org structure and SEO-friendly content. Returns ready-to-embed HTML code that displays customer reviews or badges on your website. The HTML includes structured data markup for better search engine visibility. Prerequisites: - Use GATHERUP\_SEARCH\_BUSINESS if you need to find a businessId
>
> #### Input Parameters
>
> **type** `string` *required*
>
> Widget type to generate (e.g., 'reviews', 'badge'). Determines the style and content of the HTML output.
>
> **limit** `integer`
>
> Limit the number of reviews to display in the widget. Only applicable for certain widget types.
>
> **widgetId** `integer`
>
> Widget ID for custom widgets. Use this to retrieve HTML for a specific widget configuration.
>
> **businessId** `integer` *required*
>
> The unique ID of the business for which to generate widget HTML. Use GATHERUP\_SEARCH\_BUSINESS to find business IDs.
>
> #### 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] Search GatherUp Business by Custom Identifier
>
> **Slug:** `GATHERUP_SEARCH_BUSINESS`
>
> Search for a GatherUp business location by custom identifier and retrieve its business ID. This tool locates business locations using user-defined identifiers (customField or extraField) that you've assigned in GatherUp. Returns the businessId on success (errorCode=0), or an error code with message on failure. Common error codes: 2=Invalid clientId, 25=Business not found, 26=Invalid search type Endpoint: POST /api/business/search
>
> #### Input Parameters
>
> **by** `string` *required*
>
> Field type to search by. 'customField' searches user-defined custom identifiers; 'extraField' searches user-defined extra identifiers. Allowed values: customField | extraField
>
> **search** `string` *required*
>
> The value to search for in the specified field (customField or extraField). This should match the identifier you assigned to a business location.
>
> #### 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] Send GatherUp Customer Feedback
>
> **Slug:** `GATHERUP_SEND_CUSTOMER_FEEDBACK`
>
> Send a feedback request to a customer to collect their rating and review. Use this when you want to automatically request feedback after a customer interaction or transaction. Ensure the customer exists in your GatherUp account and hasn't unsubscribed from feedback requests.
>
> #### Input Parameters
>
> **jobId** `string`
>
> Job ID from a previous feedback request. Required when ratingRevision=1 to identify which request to replace. Obtain from customer records.
>
> **customerId** `integer` *required*
>
> ID of the customer who will receive the feedback request. Must be an existing customer in your GatherUp account.
>
> **checkThreshold** `integer`
>
> Set to 1 to validate that the customer hasn't exceeded the feedback request threshold before sending, or 0 to skip threshold check. Default is 0.
>
> **ratingRevision** `integer`
>
> Set to 1 to revise/replace an existing feedback request (requires jobId), or 0 to send a new feedback request. Default is 0 for new requests.
>
> #### 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] Set GatherUp User Password
>
> **Slug:** `GATHERUP_SET_USER_PASSWORD`
>
> Sets a new password for an existing user in GatherUp. Use this action to update user credentials securely. **Prerequisites**: - Valid userId (user must exist in your GatherUp account) - Password must meet security requirements: minimum 12 characters, at least one uppercase letter and one number **When to use**: Update user passwords for security purposes or user account management. Check errorCode in response: 0=success, non-zero=error. See errorMessage for details.
>
> #### Input Parameters
>
> **userId** `integer` *required*
>
> The unique identifier of the user whose password will be set. Must be an existing user in your GatherUp account.
>
> **password** `string` *required*
>
> New password for the user. Must be at least 12 characters long and include at least one uppercase letter and one number for security requirements.
>
> #### 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
