HubSpotSettings
| 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. |
| Free text | Searches the object's default searchable properties. Leave empty to filter only. |
| Filters | One object per filter. Rows with the same group are ANDed together; different groups are ORed. Values may carry {{ }}, so a filter can come from an earlier node. |
| Sort by | One property only — HubSpot accepts exactly one sort per search. |
| Direction | "ASCENDING" or "DESCENDING" |
| Properties to fetch | Comma-separated. HubSpot leaves out anything you do not ask for. |
| Records per call | 1 to 200. HubSpot's own default is 10, so this is always sent. |
| Start after | A whole number: how many results to skip. HubSpot never answers past the 10,000th result of one search. |
| Fetch every page | Follows HubSpot's paging cursor, and refuses past 5,000 records rather than answering a short list. |
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" |
query | textits `{{ }}` must give a string |
filters | list of {group?: "1" or "2" or "3" or "4" or "5", propertyName?: text, operator?: "EQ" or "NEQ" or "LT" or "LTE" or "GT" or "GTE" or "BETWEEN" or "IN" or "NOT_IN" or "HAS_PROPERTY" or "NOT_HAS_PROPERTY" or "CONTAINS_TOKEN" or "NOT_CONTAINS_TOKEN", value?: text, highValue?: text}, by default [] |
sortProperty | text |
sortDirection | "ASCENDING" or "DESCENDING", by default "DESCENDING" |
properties | text |
limit | number, by default 100 |
after | text |
returnAll | true/false, by default false |
Output
| Field | Type |
|---|---|
records | array |
recordCountRecords in this answer | number |
totalHow many HubSpot counted | number |
hasMoreMore records are waiting behind this page | boolean |
nextCursorCursor for the next page | string |
Sample output, and the expression for each field
- hasMorefalse
- nextCursor""
- recordCount0
- records[]
- total0
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": "",
"connection": "<connection id>",
"customObjectType": "",
"filters": [],
"limit": 100,
"object": "contacts",
"properties": "",
"query": "",
"returnAll": false,
"sortDirection": "DESCENDING",
"sortProperty": ""
},
"label": "Search records",
"type": "hubspot.searchRecords",
"version": 1
}