Query companies with search API (generic request)

Invokes the CRM search API via the generic request table when no dedicated table exists for the operation. This example searches companies with a filter (e.g. last modified date) and returns selected properties. You can call other valid API paths and methods by changing Url, RequestMethod, and RequestData.

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 *
FROM generic_request
WITH (
  Url='crm/v3/objects/companies/search',
  Filter='$.results[*]',
  RequestContentTypeCode='ApplicationJson',
  RequestMethod='POST',
  RequestData='{
    "filters": [ {"propertyName": "hs_lastmodifieddate", "operator": "GT", "value": "<<yearstart-1y||unix_timestamp_ms,FUN_TO_DATE>>" } ],
    "properties": ["address","city","state"]
  }'
)

Using OPENQUERY in SQL Server

SELECT * FROM OPENQUERY([LS_TO_HUBSPOT_IN_GATEWAY], 'SELECT *
FROM generic_request
WITH (
  Url=''crm/v3/objects/companies/search'',
  Filter=''$.results[*]'',
  RequestContentTypeCode=''ApplicationJson'',
  RequestMethod=''POST'',
  RequestData=''{
    "filters": [ {"propertyName": "hs_lastmodifieddate", "operator": "GT", "value": "<<yearstart-1y||unix_timestamp_ms,FUN_TO_DATE>>" } ],
    "properties": ["address","city","state"]
  }''
)')

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 *
FROM generic_request
WITH (
  Url=''crm/v3/objects/companies/search'',
  Filter=''$.results[*]'',
  RequestContentTypeCode=''ApplicationJson'',
  RequestMethod=''POST'',
  RequestData=''{
    "filters": [ {"propertyName": "hs_lastmodifieddate", "operator": "GT", "value": "<<yearstart-1y||unix_timestamp_ms,FUN_TO_DATE>>" } ],
    "properties": ["address","city","state"]
  }''
)'
EXEC (@MyQuery) AT [LS_TO_HUBSPOT_IN_GATEWAY]