# HubSpot - Get object actions
These actions will allow you to retrieve records by an object's ID, Email, through associations to other objects or from lists.
# Objects supported
Workato currently supports the get action for these objects.
- Get company by ID
- Get contact by VID
- Get contact by email
- Get contacts associated with a company
- Get contacts in contact list
- Get deal by ID
- Get owner by email
# Get company by ID
This action retrieves details of the specific company that matches a search by company ID.
# Input fields
Input field | Description |
---|---|
Company ID | The unique ID of the company. |
# Output fields
If the request is successful, Workato will return an object representing the specific company matching the ID provided so you can use its datapills in the subsequent steps. Click here to view the fields available.
# Get contact by VID
This action retrieves details of the specific contact that matches a search by the contact VID. Additionally, you may select whether you would like to retrieve the version history of fields and/or the list memberships of the contact.
# Input fields
Input field | Description |
---|---|
Contact ID | The unique ID of the contact. |
Property mode | Select whether to retrieve the current value for each contact property or to retrieve both current value and every historical value. |
Show list members | Select an option to indicate whether current list members should be retrieved for the contact. The default is true. |
Properties | The unique ID of the contact. |
# Output fields
If the request is successful, Workato will return an object representing the specific contact matching the VID provided so you can use its datapills in the subsequent steps, the values of each property retrieved is determined by the input fields of the action. Click here to view the fields available.
# Get contact by email
This action retrieves details of the specific contact that matches a search by the contact email. Additionally, you may select whether you would like to retrieve the version history of fields and/or the list memberships of the contact, requests will only return a single contact.
# Input fields
Input field | Description |
---|---|
Contact email | The email of the contact. |
Property mode | Select whether to retrieve the current value for each contact property or to retrieve both current value and every historical value. |
Show list members | Select an option to indicate whether current list members should be retrieved for the contact. The default is true. |
Properties | The unique ID of the contact. |
# Output fields
If the request is successful, Workato will return an object representing the specific contact that matches the email address provided so you can use its datapills in the subsequent steps, the values of each property retrieved is determined by the input fields of the action. Click here to view the fields available.
# Get contacts associated with a company
This action retrieves all contacts associated with a company in HubSpot in descending order when you provide the company ID. Additionally, you may select whether you would like to retrieve the version history of fields and/or the list memberships of the contact.
# Input fields
Input field | Description |
---|---|
Company ID | The ID of the company that the contacts are associated to. |
Count | The number of contacts to be returned in your request. |
Property mode | Select whether to retrieve the current value for each contact property or to retrieve both current value and every historical value. |
Show list members | Select an option to indicate whether current list members should be retrieved for the contact. The default is true. |
Properties | The unique ID of the contact. |
# Output fields
If the request is successful, Workato will return a list of objects representing the contacts associated with the selected company so you can use its datapills in the subsequent steps, the values of each property retrieved is determined by the input fields of the action. Click here to view the fields available.
# Get contacts in contact list
This action retrieves all details about contacts in a specific contact list in HubSpot.
# Input fields
Input field | Description |
---|---|
List | List from which you want to retrieve contacts. |
Property mode | Select whether to retrieve the current value for each contact property or to retrieve both current value and every historical value. |
Show list members | Select an option to indicate whether current list members should be retrieved for the contact. The default is true. |
Properties | The unique ID of the contact. |
# Output fields
If the request is successful, Workato will return a list of objects representing the contacts in the selected contact list so you can use its datapills in the subsequent steps, the values of each property retrieved is determined by the input fields of the action. Click here to view the fields available.
# Get deal by ID
This action retrieves details of a specific deal in HubSpot that corresponds to the given deal ID.
# Input fields
Input field | Description |
---|---|
Deal ID | The ID of the deal to be retrieved. |
Include property versions | Select whether to retrieve the current value for each deal property or to retrieve both current value and every historical value. |
# Output fields
If the request is successful, Workato will return an object representing the specific deal matching the ID provided so you can use its datapills in the subsequent steps, the values of each property retrieved is determined by the input fields of the action. Click here to view the fields available.
# Get owner by email
This action retrieves all owners in a HubSpot account that matches the given email address. Additionally, you may select whether or not to retrieve inactive owners. HubSpot uses owners to assign specific users to contacts, companies, deals, tickets, or engagements. Any HubSpot user with access to contacts can be assigned as an owner, and multiple owners can be assigned to an object by creating a custom property for this purpose.
# Input fields
Input field | Description |
---|---|
Email address | The email address belonging to an owner. |
Include inactive | Select whether to retrieve owners without any active remotes. |
# Output fields
If the request is successful, Workato will return a list of owners that match the email address provided so you can use its datapills in the subsequent steps, the values of each property retrieved is determined by the input fields of the action. Click here to view the fields available.