HubSpot Settings V2 (Independent Publisher) (Preview)
HubSpot Settings allows you to retrieve information about a given HubSpot account, including the account settings, account activity, business units, and managing users.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Troy Taylor |
| Website | https://www.hubspot.com/ |
| Privacy policy | https://legal.hubspot.com/privacy-policy |
| Categories | Sales and CRM |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Access Token (in the form 'Bearer YOUR_ACCESS_TOKEN') | securestring | The Access Token (in the form 'Bearer YOUR_ACCESS_TOKEN') for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add user |
Adds a new user. New users will only have minimal permissions, which is contacts-base. A welcome email will prompt them to set a password and log in to HubSpot. |
| Get account details |
Get account details for a HubSpot account. |
| Get account roles |
Retrieves the roles on an account. |
| Get account teams |
Retrieve the details for the teams of this account. |
| Get API usage |
Get the daily API usage and limits for a HubSpot account. |
| Get business units for a user |
Get business Units identified by |
| Get login activity |
Get login activity for a HubSpot account. |
| Get security activity |
Get security activity for a HubSpot account |
| Get user |
Retrieves a user identified by |
| Get users |
Retrieves a list of users from an account. |
| Modifies a user |
Modifies a user identified by |
| Remove user |
Removes a user identified by |
Add user
Adds a new user. New users will only have minimal permissions, which is contacts-base. A welcome email will prompt them to set a password and log in to HubSpot.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Email
|
string |
The email address. |
||
|
Primary Team ID
|
primaryTeamId | string |
The primary team identifier. |
|
|
Send Welcome Email
|
sendWelcomeEmail | boolean |
Whether to send welcome email. |
|
|
Role ID
|
roleId | string |
The role identifier. |
|
|
Secondary Team IDs
|
secondaryTeamIds | array of string |
The secondary team identifiers. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Email
|
string |
The email address. |
|
|
ID
|
id | string |
The identifier. |
|
Primary Team ID
|
primaryTeamId | string |
The primary team identifier. |
|
Role IDs
|
roleIds | array of string |
The role identifiers. |
|
Send Welcome Email
|
sendWelcomeEmail | boolean |
Whether to send welcome email. |
|
Role ID
|
roleId | string |
The role identifier. |
|
Secondary Team IDs
|
secondaryTeamIds | array of string |
The secondary team identifiers. |
|
Super Admin
|
superAdmin | boolean |
Whether super admin. |
Get account details
Get account details for a HubSpot account.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Account Type
|
accountType | string |
The account type. |
|
Additional Currencies
|
additionalCurrencies | array of string |
The additional currencies. |
|
Company Currency
|
companyCurrency | string |
The company currency. |
|
Data Hosting Location
|
dataHostingLocation | string |
The data hosting location. |
|
Portal ID
|
portalId | integer |
The portal identifier. |
|
Timezone
|
timeZone | string |
The timezone. |
|
UI Domain
|
uiDomain | string |
The UI domain. |
|
UTC Offset
|
utcOffset | string |
The UTC offset. |
|
UTC Offset Milliseconds
|
utcOffsetMilliseconds | integer |
The UTC offset in milliseconds. |
Get account roles
Retrieves the roles on an account.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
The identifier. |
|
Name
|
results.name | string |
The name. |
|
Requires Billing Write
|
results.requiresBillingWrite | boolean |
Whether requires billing write. |
Get account teams
Retrieve the details for the teams of this account.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
The identifier. |
|
Name
|
results.name | string |
The name. |
|
Secondary User IDs
|
results.secondaryUserIds | array of integer |
The secondary user identifiers. |
|
User IDs
|
results.userIds | array of integer |
The user identifiers. |
Get API usage
Get the daily API usage and limits for a HubSpot account.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Collected At
|
results.collectedAt | string |
When collected at. |
|
Current Usage
|
results.currentUsage | string |
The current usage. |
|
Fetch Status
|
results.fetchStatus | string |
The fetch status. |
|
Name
|
results.name | string |
The name. |
|
Usage Limit
|
results.usageLimit | string |
The usage limit. |
|
Resets At
|
results.resetsAt | string |
When resets at. |
Get business units for a user
Get business Units identified by userId. The userId refers to the user's ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Name
|
name | string |
The name. |
|
|
User ID
|
userId | True | integer |
The user identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
The identifier. |
|
Name
|
results.name | string |
The name. |
|
Logo URL
|
results.logoMetadata.logoUrl | string |
The logo URL address. |
|
Logo Alt Text
|
results.logoMetadata.logoAltText | string |
The logo alt text. |
|
Resized URL
|
results.logoMetadata.resizedUrl | string |
The resized URL address. |
Get login activity
Get login activity for a HubSpot account.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after. |
|
|
Limit
|
limit | string |
The limit. |
|
|
User ID
|
userId | integer |
The user identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
The identifier. |
|
Login At
|
results.loginAt | string |
The login at. |
|
User ID
|
results.userId | integer |
The user identifier. |
|
Email
|
results.email | string |
The email address. |
|
Login Succeeded
|
results.loginSucceeded | boolean |
Whether the login succeeded. |
|
IP Address
|
results.ipAddress | string |
The IP address. |
|
Location
|
results.location | string |
The location. |
|
User Agent
|
results.userAgent | string |
The user agent. |
|
Country Code
|
results.countryCode | string |
The country code. |
|
Region Code
|
results.regionCode | string |
The region code. |
Get security activity
Get security activity for a HubSpot account
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after. |
|
|
Limit
|
limit | string |
The limit. |
|
|
User ID
|
userId | string |
The user identifier. |
|
|
From
|
fromTimestamp | string |
The from timestamp. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Type
|
results.type | string |
The type. |
|
User ID
|
results.userId | integer |
The user identifier. |
|
Acting User
|
results.actingUser | string |
The acting user. |
|
Object ID
|
results.objectId | string |
The object identifier. |
|
Info URL
|
results.infoUrl | string |
The info URL address. |
|
Location
|
results.location | string |
The location. |
|
IP Address
|
results.ipAddress | string |
The IP address. |
|
Country Code
|
results.countryCode | string |
The country code. |
|
Region Code
|
results.regionCode | string |
The region code. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
Get user
Retrieves a user identified by userId. userId refers to the user's ID by default, or optionally email as specified by the IdProperty query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
User ID
|
userId | True | integer |
The user identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Email
|
string |
The email address. |
|
|
ID
|
id | string |
The identifier. |
|
Primary Team ID
|
primaryTeamId | string |
The primary team identifier. |
|
Role IDs
|
roleIds | array of string |
The role identifiers. |
|
Send Welcome Email
|
sendWelcomeEmail | boolean |
Whether to send welcome email. |
|
Role ID
|
roleId | string |
The role identifier. |
|
Secondary Team IDs
|
secondaryTeamIds | array of string |
The secondary team identifiers. |
|
Super Admin
|
superAdmin | boolean |
Whether super admin. |
Get users
Retrieves a list of users from an account.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
The limit. |
|
|
After
|
after | string |
The after. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Email
|
results.email | string |
The email address. |
|
ID
|
results.id | string |
The identifier. |
|
Primary Team ID
|
results.primaryTeamId | string |
The primary team identifier. |
|
Role IDs
|
results.roleIds | array of string |
The role identifiers. |
|
Send Welcome Email
|
results.sendWelcomeEmail | boolean |
Whether send welcome email. |
|
Role ID
|
results.roleId | string |
The role identifier. |
|
Secondary Team IDs
|
results.secondaryTeamIds | array of string |
The secondary team identifiers. |
|
Super Admin
|
results.superAdmin | boolean |
Whether super admin. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
Modifies a user
Modifies a user identified by userId. userId refers to the user's ID by default, or optionally email as specified by the IdProperty query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
User ID
|
userId | True | integer |
The user identifier. |
|
Primary Team ID
|
primaryTeamId | string |
The primary team identifier. |
|
|
Role ID
|
roleId | string |
The role identifier. |
|
|
Secondary Team IDs
|
secondaryTeamIds | array of string |
The secondary team identifiers. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Email
|
string |
The email address. |
|
|
ID
|
id | string |
The identifier. |
|
Primary Team ID
|
primaryTeamId | string |
The primary team identifier. |
|
Role IDs
|
roleIds | array of string |
The role identifiers. |
|
Send Welcome Email
|
sendWelcomeEmail | boolean |
Whether to send welcome email. |
|
Role ID
|
roleId | string |
The role identifier. |
|
Secondary Team IDs
|
secondaryTeamIds | array of string |
The secondary team identifiers. |
|
Super Admin
|
superAdmin | boolean |
Whether super admin. |
Remove user
Removes a user identified by userId. userId refers to the user's ID by default, or optionally email as specified by the IdProperty query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
User ID
|
userId | True | integer |
The user identifier. |
Returns
- response
- string
Definitions
string
This is the basic data type 'string'.