HubSpotRead records in bulk
BetaReads data
Fetches up to a hundred HubSpot records by id or by a unique property.
Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The HubSpot connection the step signs in with. |
| Object | "contacts" or "companies" or "deals" or "tickets" or "notes" or "tasks" or "calls" or "meetings" or "emails" or "leads" or "products" or "line_items" or "custom" |
| Custom object type id | The object type id, e.g. 2-1234567. The List properties node shows it. |
| Record ids | A list of at most 100 ids, or of the key values when a key property is named below. |
| Look up by property | Leave empty to read by HubSpot record id. Fill in email to read contacts by e-mail, or the internal name of any unique-identifier property. |
| Properties to fetch | Comma-separated. Associated records cannot be read here — use the List associations node for those. |
| Properties with their history | Comma-separated. Each one comes back with its previous values too. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `hubspot`) |
object | "contacts" or "companies" or "deals" or "tickets" or "notes" or "tasks" or "calls" or "meetings" or "emails" or "leads" or "products" or "line_items" or "custom", by default "contacts" |
customObjectType | textused when `object` is "custom" |
recordIds | any JSONits `{{ }}` must give an array |
idProperty | text |
properties | text |
propertiesWithHistory | text |
Output
| Field | Type |
|---|---|
records | array |
recordCountRecords in this answer | number |
errorsIds HubSpot could not read | array |
numErrorsHow many it could not read | number |
Sample output, and the expression for each field
- errors[]
- numErrors0
- recordCount0
- records[]
Errors
When a step of this node stops a run, the run page shows a code. Look it up:
Example step
The step as a flow file holds it. Replace each value in <…>.
{
"config": {
"connection": "<connection id>",
"customObjectType": "",
"idProperty": "",
"object": "contacts",
"properties": "",
"propertiesWithHistory": "",
"recordIds": "<record ids>"
},
"label": "Read records in bulk",
"type": "hubspot.batchReadRecords",
"version": 1
}