Skip to main content
Gatherup logo
  • Category: reviews
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: GATHERUP
  • Version: 20261101_00

Tools

Slug: GATHERUP_DELETE_BUSINESSPermanently 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

integer
required
Unique ID of the business location to delete. Obtain this from search or get business endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GATHERUP_FIND_AGENCY_CLIENT_IDFind 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

integer
required
The unique ID of the business to find the client ID for. This identifies the specific business location in GatherUp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GATHERUP_GET_BUSINESSRetrieve 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

integer
required
The unique ID of the business to retrieve. Use GATHERUP_SEARCH_BUSINESS to find business IDs by customField or extraField.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GATHERUP_GET_BUSINESS_TYPESRetrieves 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

Optional search term to filter business types by name (e.g., ‘restaurant’, ‘hotel’, ‘cafe’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GATHERUP_GET_CUSTOMERRetrieves 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

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GATHERUP_GET_WIDGET_HTMLRetrieve 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

string
required
Widget type to generate (e.g., ‘reviews’, ‘badge’). Determines the style and content of the HTML output.
integer
Limit the number of reviews to display in the widget. Only applicable for certain widget types.
integer
Widget ID for custom widgets. Use this to retrieve HTML for a specific widget configuration.
integer
required
The unique ID of the business for which to generate widget HTML. Use GATHERUP_SEARCH_BUSINESS to find business IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GATHERUP_SEARCH_BUSINESSSearch 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

string
required
Field type to search by. ‘customField’ searches user-defined custom identifiers; ‘extraField’ searches user-defined extra identifiers. Allowed values: customField | extraField
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GATHERUP_SEND_CUSTOMER_FEEDBACKSend 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

string
Job ID from a previous feedback request. Required when ratingRevision=1 to identify which request to replace. Obtain from customer records.
integer
required
ID of the customer who will receive the feedback request. Must be an existing customer in your GatherUp account.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GATHERUP_SET_USER_PASSWORDSets 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

integer
required
The unique identifier of the user whose password will be set. Must be an existing user in your GatherUp account.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not