Reference

Endpoint Search Contacts


Name

search_contacts

Description

Search contacts using one or more filter conditions. Choose properties to include in the output.

Parameters

Parameter Required Options
Name: Properties

Label: Properties

Name: SearchFilters

Label: SearchFilters

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_WSTR nvarchar(4000) 4000
IsArchived DT_BOOL bit
CreatedAt DT_DBTIMESTAMP datetime
UpdatedAt DT_DBTIMESTAMP datetime
[Dynamic Column] DT_WSTR nvarchar(2000) 2000 [$parent.label$]
If the column you are looking for is missing, consider customizing Hubspot Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Hubspot Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - Hubspot
Read and write HubSpot data effortlessly. Integrate, manage, and automate contacts, companies, deals, and tickets — almost no coding required.
Hubspot
Search Contacts
Optional Parameters
Properties
SSIS API Source - Read from table or endpoint

API Destination

API Destination - Hubspot
Read and write HubSpot data effortlessly. Integrate, manage, and automate contacts, companies, deals, and tickets — almost no coding required.
Hubspot
Search Contacts
Optional Parameters
Properties
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Get contacts by email (search)

SELECT Id
  , IsArchived
  , CreatedAt
  , UpdatedAt
  , email
  , firstname
  , lastname
  , company_size
FROM search_contacts
WITH (SearchFilters='[ {"propertyName": "email", "operator": "EQ", "value": "bh@hubspot.com" } ]')

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get contacts by email (search)

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT Id
  , IsArchived
  , CreatedAt
  , UpdatedAt
  , email
  , firstname
  , lastname
  , company_size
FROM search_contacts
WITH (SearchFilters=''[ {"propertyName": "email", "operator": "EQ", "value": "bh@hubspot.com" } ]'')';

EXEC (@MyQuery) AT [LS_TO_HUBSPOT_IN_GATEWAY];