Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.major.build/llms.txt

Use this file to discover all available pages before exploring further.

The HubSpotResourceClient is a specialized client for interacting with the HubSpot API, providing a convenient way to access CRM objects and other HubSpot features.

​
Usage

import { myHubSpotClient } from "./clients";

const result = await myHubSpotClient.invoke(
  "GET",
  "/crm/v3/objects/contacts",
  "list-contacts",
  {
    query: { limit: "10" },
  }
);

if (result.ok && result.result.body.kind === "json") {
  console.log("Contacts:", result.result.body.value);
}

​
Search API

The HubSpot Search API allows you to query CRM objects with filtering, sorting, and pagination. Search has stricter rate limits than other API methods.

​
Rate Limits

  • Search API: 5 requests per second (much stricter than general API rate limit)
  • General API: 100 requests per 10 seconds
const result = await myHubSpotClient.invoke(
  "POST",
  "/crm/v3/objects/contacts/search",
  "search-contacts",
  {
    body: {
      type: "json",
      value: {
        filterGroups: [
          {
            filters: [
              {
                propertyName: "hs_lead_status",
                operator: "EQ",
                value: "MARKETINGSALESQUALIFIEDLEAD",
              },
            ],
          },
        ],
        sorts: ["-hs_analytics_num_page_views"],
        limit: 10,
        after: 0,
      },
    },
  }
);

​
Filter operators

OperatorDescriptionExample
EQEqual{ propertyName: "status", operator: "EQ", value: "active" }
NEQNot equal{ propertyName: "status", operator: "NEQ", value: "inactive" }
LTLess than{ propertyName: "amount", operator: "LT", value: "1000" }
LTELess than or equal{ propertyName: "amount", operator: "LTE", value: "1000" }
GTGreater than{ propertyName: "amount", operator: "GT", value: "1000" }
GTEGreater than or equal{ propertyName: "amount", operator: "GTE", value: "1000" }
INIn list{ propertyName: "status", operator: "IN", values: ["active", "pending"] }
NOT_INNot in list{ propertyName: "status", operator: "NOT_IN", values: ["inactive"] }
CONTAINS_TOKENContains (for text){ propertyName: "name", operator: "CONTAINS_TOKEN", value: "John" }
HAS_PROPERTYHas property{ propertyName: "custom_field", operator: "HAS_PROPERTY" }

​
Date formatting

For date properties, use ISO 8601 format (YYYY-MM-DD) or Unix timestamps (milliseconds): 
{
  propertyName: "createdate",
  operator: "GTE",
  value: "2024-01-01",
}

​
Pagination

Use the after parameter for cursor-based pagination: 
{
  filterGroups: [...],
  limit: 100,
  after: "MTAxNTExOTQ0NTIxNzA=", // cursor from previous response
}
The response includes a paginationCursor field if more results are available.

​
Inputs

The invoke method accepts the following arguments:
​
method
string
required
The HTTP method to use: "GET", "POST", "PUT", "PATCH", or "DELETE".
​
path
string
required
The HubSpot API path (e.g., /crm/v3/objects/contacts).
​
invocationKey
string
required
A unique identifier for this operation.
​
options
object
Optional configuration object.

​
Outputs

The output format is the same as the Custom API client.
​
kind
"api"
Discriminator for the response type.
​
status
number
The HTTP status code.
​
body
ResponseBody
The response body (typically JSON).