# HubspotUsersApi

import StarterToolInfo from "@/app/_components/starter-tool-info";
import ToolInfo from "@/app/_components/tool-info";
import Badges from "@/app/_components/badges";
import TabbedCodeBlock from "@/app/_components/tabbed-code-block";
import TableOfContents from "@/app/_components/table-of-contents";
import ToolFooter from "@/app/_components/tool-footer";
import { Callout } from "nextra/components";

<ToolInfo
  description="Tools that enable LLMs to interact directly with the Hubspot Users API"
  author="Arcade"
  authType="OAuth2"
  versions={["0.1.0"]}
/>

<Badges repo="arcadeai/arcade_hubspot_users_api" />

<StarterToolInfo toolkitName="HubspotUsersApi" />

The HubspotUsersApi MCP Server provides a comprehensive set of tools for managing users and teams within a HubSpot account. With this server, users can:

- Retrieve lists of users, teams, and roles associated with the account.
- Create new users with basic permissions.
- Update user information and manage user accounts.
- Remove users from the HubSpot system as needed.

This server streamlines user management and enhances team collaboration within HubSpot.

## Available Tools

<TableOfContents
  headers={["Tool Name", "Description"]}
  data={[
    ["HubspotUsersApi.ViewAccountTeams", "Retrieve all teams for the account."],
    [
      "HubspotUsersApi.GetAccountRoles",
      "Retrieve all user roles from an account.",
    ],
    [
      "HubspotUsersApi.FetchHubspotUsersList",
      "Retrieve a list of users from a HubSpot account.",
    ],
    [
      "HubspotUsersApi.CreateHubspotUser",
      "Create a new user in HubSpot with basic permissions.",
    ],
    [
      "HubspotUsersApi.RetrieveHubspotUserById",
      "Retrieve Hubspot user details using user ID or email.",
    ],
    [
      "HubspotUsersApi.UpdateHubspotUserInfo",
      "Update information for a specified Hubspot user.",
    ],
    [
      "HubspotUsersApi.RemoveUserHubspot",
      "Remove a user from HubSpot using their ID or email.",
    ],
  ]}
/>

<Callout>
  If you need to perform an action that's not listed here, you can [get in touch
  with us](mailto:contact@arcade.dev) to request a new tool, or [create your own
  tools](/guides/create-tools/tool-basics/build-mcp-server).
</Callout>

## HubspotUsersApi.ViewAccountTeams

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/hubspot_users_api/view_account_teams_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/hubspot_users_api/view_account_teams_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all teams for the account.

**Parameters**

This tool does not take any parameters.

## HubspotUsersApi.GetAccountRoles

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/hubspot_users_api/get_account_roles_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/hubspot_users_api/get_account_roles_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all user roles from an account.

**Parameters**

This tool does not take any parameters.

## HubspotUsersApi.FetchHubspotUsersList

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/hubspot_users_api/fetch_hubspot_users_list_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/hubspot_users_api/fetch_hubspot_users_list_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of users from a HubSpot account.

**Parameters**

- **page_cursor_after** (`string`, optional) A string token used to retrieve the next page of users, if more than 100 users are available.
- **user_retrieval_limit** (`integer`, optional) Specify the maximum number of users to retrieve from the HubSpot account.

## HubspotUsersApi.CreateHubspotUser

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/hubspot_users_api/create_hubspot_user_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/hubspot_users_api/create_hubspot_user_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Create a new user in HubSpot with basic permissions.

**Parameters**

- **user_email** (`string`, required) The email address of the user to be created in HubSpot.
- **additional_team_ids** (`array[string]`, optional) List of IDs representing the user's additional teams.
- **last_name** (`string`, optional) The last name of the user to be created in HubSpot.
- **primary_team_id** (`string`, optional) The identifier for the user's primary team in HubSpot.
- **send_welcome_email** (`boolean`, optional) Set to true to send a welcome email prompting the user to set a password and log in.
- **user_first_name** (`string`, optional) The first name of the user to be created in HubSpot.
- **user_role_id** (`string`, optional) A string representing the new user's role within HubSpot.

## HubspotUsersApi.RetrieveHubspotUserById

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/hubspot_users_api/retrieve_hubspot_user_by_id_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/hubspot_users_api/retrieve_hubspot_user_by_id_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve Hubspot user details using user ID or email.

**Parameters**

- **user_identifier** (`string`, required) Identifier of the Hubspot user to retrieve. It can be the user ID or email based on the `id_property`.
- **user_identifier_property** (`string`, optional) Specifies the property to identify the user: `USER_ID` (default) or `EMAIL`.

## HubspotUsersApi.UpdateHubspotUserInfo

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/hubspot_users_api/update_hubspot_user_info_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/hubspot_users_api/update_hubspot_user_info_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update information for a specified Hubspot user.

**Parameters**

- **user_identifier** (`string`, required) The unique identifier for the user. Can be the user's ID or email, based on the `id_property`.
- **additional_teams_ids** (`array[string]`, optional) An array of strings representing the IDs of the user's additional teams.
- **first_name** (`string`, optional) The first name of the user to update. This should be a string value.
- **last_name** (`string`, optional) The last name of the user to be modified. This is the new value of the user's last name.
- **user_identifier_property** (`string`, optional) Specifies if the user is identified by 'USER_ID' or 'EMAIL'. Default is 'USER_ID'.
- **user_primary_team_id** (`string`, optional) The unique ID for the user's primary team.
- **user_role_id** (`string`, optional) The ID representing the user's role. Used to assign the user a specific role within the system.

## HubspotUsersApi.RemoveUserHubspot

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/hubspot_users_api/remove_user_hubspot_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/hubspot_users_api/remove_user_hubspot_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Remove a user from HubSpot using their ID or email.

**Parameters**

- **user_identifier** (`string`, required) Identifier of the user to remove from HubSpot. It can be a user ID or an email address.
- **user_identifier_property** (`string`, optional) Specify whether to use `USER_ID` or `EMAIL` to identify the user.

## Auth

The HubspotUsersApi MCP Server uses the Auth Provider with id `arcade-hubspot` to connect to users' HubspotUsersApi accounts. In order to use the MCP Server, you will need to configure the `arcade-hubspot` auth provider.

<ToolFooter pipPackageName="arcade_hubspot_users_api" />