FlowmageDocs

List records

BetaReads data

Lists HubSpot records of one object, newest ids last.

Settings

SettingWhat it is
ConnectionRequiredThe 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 idThe object type id, e.g. 2-1234567. The List properties node shows it.
Properties to fetchComma-separated. HubSpot leaves out anything you do not ask for.
Associated objectsComma-separated object names to return associated ids for.
Look in the recycling bintrue/false
Records per call1 to 100. HubSpot's own default is 10, so this is always sent.
Start afterA paging cursor from an earlier run of this node. Leave empty to start over.
Fetch every pageFollows HubSpot's paging cursor, and refuses past 5,000 records rather than answering a short list.
Technical details
KeyValue
connectiontexta 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"
customObjectTypetextused when `object` is "custom"
propertiestext
associationstext
archivedtrue/false, by default false
limitnumber, by default 100
aftertext
returnAlltrue/false, by default false

Output

FieldType
recordsarray
recordCountRecords in this answernumber
hasMoreMore records are waiting behind this pageboolean
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • hasMorefalse
  • nextCursor""
  • 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": {
    "after": "",
    "archived": false,
    "associations": "",
    "connection": "<connection id>",
    "customObjectType": "",
    "limit": 100,
    "object": "contacts",
    "properties": "",
    "returnAll": false
  },
  "label": "List records",
  "type": "hubspot.listRecords",
  "version": 1
}