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

# HelpSpot

> HelpSpot is a customer support platform for managing requests, staff workflows, time tracking, saved responses, reports, and help desk metadata.

![HelpSpot logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/help_spot.svg?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=7d02e508cdfade532c8d6036e3cbfd43)

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

## Tools

> [accordion] Create Request
>
> **Slug:** `HELP_SPOT_CREATE_REQUEST`
>
> Create a staff-side support request with an initial customer-visible or internal note. Configured HelpSpot automations may send notifications.
>
> #### Input Parameters
>
> **note** `string` *required*
>
> Initial request note content.
>
> **title** `string`
>
> Short request title or subject.
>
> **is\_open** `boolean`
>
> Whether the new request starts open.
>
> **is\_urgent** `boolean`
>
> Whether to mark the request urgent.
>
> **portal\_id** `integer`
>
> Portal ID associated with the request when the installation has multiple portals.
>
> **status\_id** `integer`
>
> Initial status ID from HELP\_SPOT\_LIST\_SUPPORT\_OPTIONS.
>
> **category\_id** `integer` *required*
>
> HelpSpot category ID from HELP\_SPOT\_LIST\_SUPPORT\_OPTIONS.
>
> **customer\_id** `string`
>
> Existing customer's HelpSpot user ID; provide at least one customer identity field.
>
> **custom\_fields** `array`
>
> Custom-field values keyed by IDs returned from HELP\_SPOT\_LIST\_SUPPORT\_OPTIONS.
>
> **customer\_email** `string`
>
> Customer email address; provide at least one customer identity field.
>
> **customer\_phone** `string`
>
> Customer phone number; may serve as the required customer identity.
>
> **note\_visibility** `string ("customer" | "internal")`
>
> Whether the initial note is visible to the customer or only to staff.
>
> **assigned\_staff\_id** `integer`
>
> Active staff ID to assign, from HELP\_SPOT\_LIST\_SUPPORT\_OPTIONS.
>
> **customer\_last\_name** `string`
>
> Customer last name; may serve as the required customer identity.
>
> **customer\_first\_name** `string`
>
> Customer first name; may serve as the required customer identity.
>
> #### 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 Current User
>
> **Slug:** `HELP_SPOT_GET_CURRENT_USER`
>
> Return the connected HelpSpot staff user's identity, defaults, and support capabilities without authentication tokens.
>
> #### 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 Request
>
> **Slug:** `HELP_SPOT_GET_REQUEST`
>
> Return one support request with optional normalized history and time total. If the requested ID was merged, HelpSpot returns the merged request with a different ID.
>
> #### Input Parameters
>
> **request\_id** `integer` *required*
>
> Numeric HelpSpot request ID.
>
> **include\_history** `boolean`
>
> Include request notes and history; disable for a smaller response.
>
> **include\_time\_total** `boolean`
>
> Include the request's accumulated time total when available.
>
> #### 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 Filters
>
> **Slug:** `HELP_SPOT_LIST_FILTERS`
>
> List the connected staff user's saved and built-in queue filters, including symbolic selectors such as inbox and myq.
>
> #### 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 Saved Responses
>
> **Slug:** `HELP_SPOT_LIST_SAVED_RESPONSES`
>
> List reusable response templates available to the connected staff user, either all templates or the user's ten most-used templates.
>
> #### Input Parameters
>
> **view** `string ("all" | "most_used")`
>
> Return every available template or only the connected user's ten most-used templates.
>
> #### 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 Support Options
>
> **Slug:** `HELP_SPOT_LIST_SUPPORT_OPTIONS`
>
> List HelpSpot categories, statuses, custom fields, mailboxes, or active staff for request setup. Custom-field names may be returned as numeric IDs instead of labels.
>
> #### Input Parameters
>
> **active\_only** `boolean`
>
> For statuses and mailboxes, omit inactive records; staff is already limited to active staff by HelpSpot.
>
> **category\_id** `integer`
>
> For custom\_fields only, restrict definitions to one category.
>
> **option\_type** `string ("categories" | "statuses" | "custom_fields" | "mailboxes" | "staff")` *required*
>
> Kind of request setup value to list.
>
> #### 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] Run Filter
>
> **Slug:** `HELP_SPOT_RUN_FILTER`
>
> Return one cursor-controlled page of request summaries from a saved or built-in HelpSpot queue filter.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Offset cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
>
> **filter\_id** `string` *required*
>
> Numeric or symbolic filter selector returned by HELP\_SPOT\_LIST\_FILTERS, such as inbox or myq.
>
> **page\_size** `integer`
>
> Requested number of requests in this page, from 1 to 100.
>
> #### 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 Requests
>
> **Slug:** `HELP_SPOT_SEARCH_REQUESTS`
>
> Search support requests by text, customer, state, assignment, or date and return one concise cursor-controlled page.
>
> #### Input Parameters
>
> **match** `string ("all" | "any")`
>
> Require all supplied filters or allow any supplied filter to match.
>
> **query** `string`
>
> Text to search across request content.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call. It retains the search filters and page size; omit it for the first page.
>
> **is\_open** `boolean`
>
> Restrict results to open or closed requests.
>
> **page\_size** `integer`
>
> Requested number of results in this page, from 1 to 100.
>
> **status\_id** `integer`
>
> Restrict results to a HelpSpot status ID.
>
> **request\_id** `integer`
>
> Restrict results to one numeric HelpSpot request ID.
>
> **category\_id** `integer`
>
> Restrict results to a HelpSpot category ID.
>
> **customer\_id** `string`
>
> Restrict results to a customer HelpSpot user ID.
>
> **closed\_after** `integer`
>
> Return requests closed after this Unix timestamp.
>
> **opened\_after** `integer`
>
> Return requests opened after this Unix timestamp.
>
> **closed\_before** `integer`
>
> Return requests closed before this Unix timestamp.
>
> **opened\_before** `integer`
>
> Return requests opened before this Unix timestamp.
>
> **relative\_date** `string ("today" | "yesterday" | "past_7" | "past_14" | "past_30" | "past_90" | "past_365" | "this_week" | "this_month" | "this_year" | "last_week" | "last_month" | "last_year")`
>
> Apply one HelpSpot relative-date window instead of calculating timestamps.
>
> **customer\_email** `string`
>
> Restrict results to a customer email address.
>
> **customer\_phone** `string`
>
> Match a customer phone number.
>
> **assigned\_staff\_id** `integer`
>
> Restrict results to the assigned HelpSpot staff ID.
>
> **customer\_last\_name** `string`
>
> Match a customer last name.
>
> **include\_time\_total** `boolean`
>
> Include accumulated time totals in each result when available.
>
> **customer\_first\_name** `string`
>
> Match a customer first name.
>
> #### 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 Request Subscription
>
> **Slug:** `HELP_SPOT_SET_REQUEST_SUBSCRIPTION`
>
> Subscribe or unsubscribe a staff user from updates to one support request.
>
> #### Input Parameters
>
> **staff\_id** `integer` *required*
>
> Staff ID to subscribe or unsubscribe; use Get Current User or List Support Options to find it.
>
> **request\_id** `integer` *required*
>
> Numeric HelpSpot request ID.
>
> **subscribed** `boolean` *required*
>
> True to subscribe the staff user; false to unsubscribe them.
>
> #### 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] Update Request
>
> **Slug:** `HELP_SPOT_UPDATE_REQUEST`
>
> Update request, customer, assignment, and state fields and optionally append one customer-visible or internal note. Configured HelpSpot notifications may be sent.
>
> #### Input Parameters
>
> **note** `string`
>
> Note to append to the request.
>
> **title** `string`
>
> Replacement request title or subject.
>
> **is\_open** `boolean`
>
> Set whether the request is open.
>
> **is\_urgent** `boolean`
>
> Set whether the request is urgent.
>
> **status\_id** `integer`
>
> Replacement status ID.
>
> **request\_id** `integer` *required*
>
> Numeric HelpSpot request ID to update.
>
> **category\_id** `integer`
>
> Replacement category ID.
>
> **customer\_id** `string`
>
> Replacement customer HelpSpot user ID.
>
> **custom\_fields** `array`
>
> Custom-field replacements keyed by numeric HelpSpot field ID.
>
> **customer\_email** `string`
>
> Replacement customer email address.
>
> **customer\_phone** `string`
>
> Replacement customer phone number.
>
> **note\_visibility** `string ("customer" | "internal")`
>
> Visibility of the appended note; used only when note is supplied.
>
> **assigned\_staff\_id** `integer`
>
> Replacement assigned staff ID.
>
> **customer\_last\_name** `string`
>
> Replacement customer last name.
>
> **customer\_first\_name** `string`
>
> Replacement customer first name.
>
> #### 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
