---
canonical_url: "https://docs.composio.dev/toolkits/help_spot"
markdown_url: "https://docs.composio.dev/toolkits/help_spot.md"
product: "platform"
version: null
last_updated: null
---

# HelpSpot

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

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

## Tools

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | Yes | Initial request note content. |
| `title` | string | No | Short request title or subject. |
| `is_open` | boolean | No | Whether the new request starts open. |
| `is_urgent` | boolean | No | Whether to mark the request urgent. |
| `portal_id` | integer | No | Portal ID associated with the request when the installation has multiple portals. |
| `status_id` | integer | No | Initial status ID from HELP_SPOT_LIST_SUPPORT_OPTIONS. |
| `category_id` | integer | Yes | HelpSpot category ID from HELP_SPOT_LIST_SUPPORT_OPTIONS. |
| `customer_id` | string | No | Existing customer's HelpSpot user ID; provide at least one customer identity field. |
| `custom_fields` | array | No | Custom-field values keyed by IDs returned from HELP_SPOT_LIST_SUPPORT_OPTIONS. |
| `customer_email` | string | No | Customer email address; provide at least one customer identity field. |
| `customer_phone` | string | No | Customer phone number; may serve as the required customer identity. |
| `note_visibility` | string ("customer" | "internal") | No | Whether the initial note is visible to the customer or only to staff. |
| `assigned_staff_id` | integer | No | Active staff ID to assign, from HELP_SPOT_LIST_SUPPORT_OPTIONS. |
| `customer_last_name` | string | No | Customer last name; may serve as the required customer identity. |
| `customer_first_name` | string | No | Customer first name; may serve as the required customer identity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Request

**Slug:** `HELP_SPOT_GET_REQUEST`

Return one support request with normalized history and optional time total; fail clearly when HelpSpot returns its sparse HTTP-200 missing-request shape.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | integer | Yes | Numeric HelpSpot request ID. |
| `include_history` | boolean | No | Include request notes and history; disable for a smaller response. |
| `include_time_total` | boolean | No | Include the request's accumulated time total when available. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view` | string ("all" | "most_used") | No | Return every available template or only the connected user's ten most-used templates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Support Options

**Slug:** `HELP_SPOT_LIST_SUPPORT_OPTIONS`

List IDs and labels used to categorize, assign, route, or set the status of HelpSpot requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `active_only` | boolean | No | For statuses and mailboxes, omit inactive records; staff is already limited to active staff by HelpSpot. |
| `category_id` | integer | No | For custom_fields only, restrict definitions to one category. |
| `option_type` | string ("categories" | "statuses" | "custom_fields" | "mailboxes" | "staff") | Yes | Kind of request setup value to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Offset cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue. |
| `filter_id` | string | Yes | Numeric or symbolic filter selector returned by HELP_SPOT_LIST_FILTERS, such as inbox or myq. |
| `page_size` | integer | No | Requested number of requests in this page, from 1 to 100. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `match` | string ("all" | "any") | No | Require all supplied filters or allow any supplied filter to match. |
| `query` | string | No | Text to search across request content. |
| `cursor` | string | No | Continuation cursor returned by a previous call. It retains the search filters and page size; omit it for the first page. |
| `is_open` | boolean | No | Restrict results to open or closed requests. |
| `page_size` | integer | No | Requested number of results in this page, from 1 to 100. |
| `status_id` | integer | No | Restrict results to a HelpSpot status ID. |
| `request_id` | integer | No | Restrict results to one numeric HelpSpot request ID. |
| `category_id` | integer | No | Restrict results to a HelpSpot category ID. |
| `customer_id` | string | No | Restrict results to a customer HelpSpot user ID. |
| `closed_after` | integer | No | Return requests closed after this Unix timestamp. |
| `opened_after` | integer | No | Return requests opened after this Unix timestamp. |
| `closed_before` | integer | No | Return requests closed before this Unix timestamp. |
| `opened_before` | integer | No | 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") | No | Apply one HelpSpot relative-date window instead of calculating timestamps. |
| `customer_email` | string | No | Restrict results to a customer email address. |
| `customer_phone` | string | No | Match a customer phone number. |
| `assigned_staff_id` | integer | No | Restrict results to the assigned HelpSpot staff ID. |
| `customer_last_name` | string | No | Match a customer last name. |
| `include_time_total` | boolean | No | Include accumulated time totals in each result when available. |
| `customer_first_name` | string | No | Match a customer first name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Request Subscription

**Slug:** `HELP_SPOT_SET_REQUEST_SUBSCRIPTION`

Subscribe or unsubscribe a staff user from updates to one support request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `staff_id` | integer | Yes | Staff ID to subscribe or unsubscribe; use Get Current User or List Support Options to find it. |
| `request_id` | integer | Yes | Numeric HelpSpot request ID. |
| `subscribed` | boolean | Yes | True to subscribe the staff user; false to unsubscribe them. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | No | Note to append to the request. |
| `title` | string | No | Replacement request title or subject. |
| `is_open` | boolean | No | Set whether the request is open. |
| `is_urgent` | boolean | No | Set whether the request is urgent. |
| `status_id` | integer | No | Replacement status ID. |
| `request_id` | integer | Yes | Numeric HelpSpot request ID to update. |
| `category_id` | integer | No | Replacement category ID. |
| `customer_id` | string | No | Replacement customer HelpSpot user ID. |
| `custom_fields` | array | No | Custom-field replacements keyed by numeric HelpSpot field ID. |
| `customer_email` | string | No | Replacement customer email address. |
| `customer_phone` | string | No | Replacement customer phone number. |
| `note_visibility` | string ("customer" | "internal") | No | Visibility of the appended note; used only when note is supplied. |
| `assigned_staff_id` | integer | No | Replacement assigned staff ID. |
| `customer_last_name` | string | No | Replacement customer last name. |
| `customer_first_name` | string | No | Replacement customer first name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |