Retrieves contact records from HubSpot CRM with customizable properties and filters
Retrieves contact records from HubSpot CRM with customizable properties and filters. Returns contact details including name, email, phone, company, lifecycle stage, and other contact properties.
List of contact properties to retrieve. Common properties include: firstname, lastname, email, phone, company, website, jobtitle, lifecyclestage, hs_lead_status, createdate, lastmodifieddate.
filters
array of FilterItem
No
-
List of filters to apply to contacts. Each filter must have a field, operator, and value. Example: filter by email domain, lifecycle stage, etc.
orders
array of OrderItem
No
-
List of fields to sort the report by. Each order must have a field and direction. The field must be one of the current selected properties.
limit
integer
No
10000
Maximum number of contacts to return. Default is 10000, maximum is 100000.
The field to filter on, must be one of the current selected metrics or dimensions.
operator
string
Yes
-
The operator to use for filtering. Must be one of the supported values. Use REGEXP_MATCH to search/filter by multiple OR values like ’.(summer|holiday).’
value
string
Yes
-
The value to filter by, always as a string: text, a number, or a regex. For IN_LIST and NOT_IN_LIST, pass the values as one comma-separated string such as ‘a,b,c’, not as an array. For regex values, escape backslashes once in the JSON string: write \b for a word boundary, not \b.