HubSpot Users API
Tools that enable LLMs to interact directly with the Hubspot Users API
1.0.0
Arcade's HubspotUsersApi toolkit allows developers to interact seamlessly with the HubSpot Users API, enabling efficient management of user data and roles within HubSpot accounts.
Capabilities
- Create, retrieve, update, and remove users in HubSpot.
- Fetch user roles and teams associated with specific accounts.
- Manage user permissions effectively through targeted API calls.
OAuth
- This toolkit utilizes OAuth2 for authentication, requiring the following scopes: crm.objects.users.read, crm.objects.users.write, settings.users.read, settings.users.teams.read, settings.users.write.
Available tools(7)
| Tool name | Description | Secrets | |
|---|---|---|---|
Create a new user in HubSpot with basic permissions.
This tool creates a new user in HubSpot with minimal permissions (contacts-base). The user will receive a welcome email to set a password and log in. | |||
Retrieve a list of users from a HubSpot account.
Use this tool to get a list of users associated with a specific HubSpot account. It is useful for managing or viewing user information within the account. | |||
Retrieve all user roles from an account.
This tool is called to fetch and list all the roles available on a specific account from Hubspot. | |||
Remove a user from HubSpot using their ID or email.
This tool removes a user from HubSpot, identified by either their user ID or email. It should be called when a user needs to be permanently deleted or archived from the HubSpot system. | |||
Retrieve Hubspot user details using user ID or email.
Call this tool to retrieve detailed information about a Hubspot user identified by their user ID or optionally by email. | |||
Update information for a specified Hubspot user.
This tool modifies the information of a Hubspot user identified by `userId`. It can be called when you need to update user data using their ID or email. | |||
Retrieve all teams for the account.
Call this tool to view all teams associated with a specific account in Hubspot. Useful for managing or reviewing team structures. |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
HubspotUsersApi.CreateHubspotUser
Create a new user in HubSpot with basic permissions. This tool creates a new user in HubSpot with minimal permissions (contacts-base). The user will receive a welcome email to set a password and log in.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'post-/settings/v3/users/_create'.HubspotUsersApi.FetchHubspotUsersList
Retrieve a list of users from a HubSpot account. Use this tool to get a list of users associated with a specific HubSpot account. It is useful for managing or viewing user information within the account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'get-/settings/v3/users/_getPage'.HubspotUsersApi.GetAccountRoles
Retrieve all user roles from an account. This tool is called to fetch and list all the roles available on a specific account from Hubspot.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/settings/v3/users/roles_getAll'.HubspotUsersApi.RemoveUserHubspot
Remove a user from HubSpot using their ID or email. This tool removes a user from HubSpot, identified by either their user ID or email. It should be called when a user needs to be permanently deleted or archived from the HubSpot system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'delete-/settings/v3/users/{userId}_archive'.HubspotUsersApi.RetrieveHubspotUserById
Retrieve Hubspot user details using user ID or email. Call this tool to retrieve detailed information about a Hubspot user identified by their user ID or optionally by email.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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`. |
Requirements
Output
json— Response from the API endpoint 'get-/settings/v3/users/{userId}_getById'.HubspotUsersApi.UpdateHubspotUserInfo
Update information for a specified Hubspot user. This tool modifies the information of a Hubspot user identified by `userId`. It can be called when you need to update user data using their ID or email.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'put-/settings/v3/users/{userId}_replace'.HubspotUsersApi.ViewAccountTeams
Retrieve all teams for the account. Call this tool to view all teams associated with a specific account in Hubspot. Useful for managing or reviewing team structures.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/settings/v3/users/teams_getAll'.