HubSpot NodeJS API SDK

Use the searchApi.doSearch method to query objects with filters and sorting.

Constraints:

• Supports a maximum of 3 FilterGroups, each with a maximum of 3 Filters.
• Only one sort parameter is supported at a time.
• For the initial search, after should be set to 0.

Sorting in JavaScript:

1. propertyName: Sorts by property in ASCENDING order (e.g., 'hs_object_id').
2. { propertyName, direction }: Explicit direction (e.g., { propertyName: 'hs_object_id', direction: 'DESCENDING' }).

Sorting in TypeScript:

1. ['propertyName']: Sorts in ASCENDING order.
2. ['-propertyName']: Sorts in DESCENDING order.

// JS Search Example
const publicObjectSearchRequest = {
    filterGroups: [{
        filters: [{
            propertyName: 'createdate',
            operator: 'GTE',
            value: `${Date.now() - 30 * 60000}`
        }]
    }],
    sorts: [{ propertyName: 'createdate', direction: 'DESCENDING' }],
    properties: ['createdate', 'firstname', 'lastname'],
    limit: 100,
    after: 0,
};

const response = await hubspotClient.crm.contacts.searchApi.doSearch(publicObjectSearchRequest);

To use the SDK, create a new instance of the Client class. You can authenticate using an accessToken (from a Private App or OAuth2) or a developerApiKey.

Common configuration options include:

• accessToken: Your HubSpot access token.
• developerApiKey: Your developer API key.
• basePath: A custom base URL for requests.
• defaultHeaders: An object of custom headers to include in every request.
• limiterOptions: Configuration for rate limiting via Bottleneck.
• numberOfApiCallRetries: Number of retries (0-6) for failed 429 or 5xx requests.

// CommonJS
const hubspot = require('@hubspot/api-client');
const hubspotClient = new hubspot.Client({ accessToken: 'YOUR_ACCESS_TOKEN' });

// ES Modules
import { Client } from "@hubspot/api-client";
const hubspotClient = new Client({ accessToken: 'YOUR_ACCESS_TOKEN' });

// With custom headers and base path
const hubspotClient = new hubspot.Client({
    accessToken: 'YOUR_ACCESS_TOKEN',
    basePath: 'https://some-url',
    defaultHeaders: { 'My-header': 'test-example' }
});

The SDK provides high-level wrappers for CRM operations. All methods return a Promise.

Create and Associate Objects: To create a Contact and a Company and then link them using Association v4:

const contactObj = { properties: { firstname: 'John', lastname: 'Doe' } };
const companyObj = { properties: { domain: 'example.com', name: 'Example Corp' } };

const createContactResponse = await hubspotClient.crm.contacts.basicApi.create(contactObj);
const createCompanyResponse = await hubspotClient.crm.companies.basicApi.create(companyObj);

await hubspotClient.crm.associations.v4.basicApi.create(
    'companies',
    createCompanyResponse.id,
    'contacts',
    createContactResponse.id,
    [{ "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": AssociationTypes.companyToContact }]
);

Batch Update: Use batchApi.update to update multiple objects of the same type in a single call.

const dealObj = { id: '123', properties: { amount: 100 } };
const dealObj2 = { id: '456', properties: { amount: 200 } };

await hubspotClient.crm.deals.batchApi.update({ inputs: [dealObj, dealObj2] });

// Example: Batch Update
const dealObj = { id: 'yourId', properties: { amount: 'yourValue' } };
const dealObj2 = { id: 'yourId2', properties: { amount: 'yourValue2' } };
await hubspotClient.crm.deals.batchApi.update({ inputs: [dealObj, dealObj2] });