Batch Read Contacts
hubspot.batch_read_contacts
ActionCRM & salesconnection required
Calls the HubSpot API with the connection's credentials.
Read up to 100 contacts in one call with POST /crm/v3/objects/contacts/batch/read, by record id or by a unique property such as email.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- HubSpot
- Secret shape
- the HubSpot private-app token, or {"token": "…"}
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
ids The contact ids to read, as a JSON array of strings — or the email addresses when `id_property` is email. At most 100 per call. | array | Yes | — | array of string | ["101","202"] |
properties Comma-separated HubSpot property names to return. HubSpot returns only its own default set when this is blank; use hubspot.list_properties to discover custom ones. | string | No | — | — | — |
id_property A unique property to use as the key instead of the record id — email for a contact, domain for a company, or any custom unique property. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"ids": [
"101",
"202"
]
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
results The records HubSpot returned, each with its id and properties. | array | — |
count How many records came back. | number | — |
status HubSpot's batch status, COMPLETE for a fully successful call. | string | — |
errors Per-input errors on a partially successful batch. | array | — |
{
"count": 0,
"errors": [],
"results": [],
"status": ""
}Notes
- A batch read cannot return associations; read them with hubspot.list_associations instead.
See Batch Read Contacts run in a workflow.
In a technical demo we add the HubSpot connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.