Get contacts by email (search)

Returns contacts matching a search filter. This example filters by email; you can change the filter to other properties. SearchFilters is a JSON array of filter objects (property name, operator, value).

Standard SQL query example

This is the base query accepted by the connector. To execute it in SQL Server, you have to pass it to the Data Gateway via a Linked Server. See how to accomplish this using the examples below.

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

Using OPENQUERY in SQL Server

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

Using EXEC in SQL Server (handling larger SQL text)

The major drawback of OPENQUERY is its inability to incorporate variables within SQL statements. This often leads to the use of cumbersome dynamic SQL (with numerous ticks and escape characters).

Fortunately, starting with SQL 2005 and onwards, you can utilize the EXEC (your_sql) AT [LS_TO_HUBSPOT_IN_GATEWAY] syntax.

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]