HubSpot: Search for notes based on specified criteria

← Notes operations · Get started

Operation hubspot.notes_search_notes

Provider route: POST /crm/objects/2026-09/notes/search. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["notes"]["searchNotes"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.notes.searchNotes(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.notes.search_notes(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Search for notes based on specified criteria — request body — body

Referenced models: Search for notes based on specified criteria — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Search for notes based on specified criteria — response body

Referenced models: Search for notes based on specified criteria — response body

Schemas

1 more schema is linked from the tables above, on the schema pages.

Search for notes based on specified criteria — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string representing the paging cursor token of the last successfully read resource. It is used for pagination to retrieve the next set of results.
filterGroups	array	Required within parent	An array of filter groups used to specify the search criteria. Each filter group contains filters that determine which objects are included in the search results.
filterGroups[]	Model	Each item	Expand Search for notes based on specified criteria — request body — body filter Groups item
limit	integer	Required within parent	An integer specifying the maximum number of results to return. It defines the page size for the search results. Format: int32
properties	array	Required within parent	An array of strings specifying which properties of the CRM objects should be returned in the search results.
properties[]	string	Each item
query	string	Optional	A string representing a search query to match against the CRM objects.
sorts	array	Required within parent	An array of strings specifying the sorting order of the search results. Each string represents a property to sort by, optionally prefixed with a '-' to indicate descending order.
sorts[]	string	Each item

Referenced models: Search for notes based on specified criteria — request body — body filter Groups item

Search for notes based on specified criteria — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a list of simple objects returned from an API request, along with the total count of objects available.
paging	Model	Optional	Expand Search for notes based on specified criteria — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing an individual object in the collection.
results[]	Model	Each item	Expand Create — notes create Note — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The number of available results Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search for notes based on specified criteria — response body — paging, Create — notes create Note — response body

Search for notes based on specified criteria — request body — body filter Groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints.
filters	array	Required within parent	An array of filters that define the criteria for the filter group. Each filter specifies a property name, an operator, and a value or range of values to filter by.
filters[]	Model	Each item	Expand Search for notes based on specified criteria — request body — body filter Groups item filters item

Referenced models: Search for notes based on specified criteria — request body — body filter Groups item filters item

Search for notes based on specified criteria — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand List — notes get Notes — response body — paging next
prev	Model	Optional	Expand Search for leads using specified criteria — response body — paging prev

Referenced models: Search for leads using specified criteria — response body — paging prev, List — notes get Notes — response body — paging next

Create — notes create Note — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object, represented as a string.
objectWriteTraceId	string	Optional	A string representing the trace ID for object write operations.
properties	object	Required within parent	A map of property names to their values for this object, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their historical values, where each value is an array of objects containing the value and timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — notes get Note — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string containing the URL of the object.
warnings	array	Optional	An array of warnings associated with this object, where each warning includes a category, message, and context.
warnings[]	Model	Each item	Expand Create a company — response body — warnings item

Referenced models: Create a company — response body — warnings item, Read — notes get Note — response body — properties With History value item

Search for notes based on specified criteria — request body — body filter Groups item filters item

Field	Type	Presence	Description and constraints
$	object	Root	Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
highValue	string	Optional	The upper bound value used in range filters. It is a string representing the maximum value for the property when using operators like 'BETWEEN'.
operator	string	Required within parent	The operator used to compare the property value against the filter value(s). It is a string and valid operators include 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', and 'NOT_CONTAINS_TOKEN'. One of: BETWEEN, CONTAINS_TOKEN, EQ, GT, GTE, HAS_PROPERTY, IN, LT, LTE, NEQ, NOT_CONTAINS_TOKEN, NOT_HAS_PROPERTY, NOT_IN
propertyName	string	Required within parent	The name of the property on which the filter is applied. It is a string that specifies which property of the object is being filtered.
value	string	Optional	The specific value that the property should match for the filter to apply. It is a string representing the expected value of the property.
values	array	Optional	An array of strings representing multiple values that the property can match. This is used with operators like 'IN' or 'NOT_IN'.
values[]	string	Each item

Search for leads using specified criteria — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string token that indicates the position of the last item on the previous page, used for pagination.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

List — notes get Notes — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string that serves as a cursor token, indicating the position after the last item on the current page. This token is used to fetch the next page of results.
link	string	Optional	A string containing the URL link to the next page of results, allowing for easy navigation to the subsequent data set.

Create a company — response body — warnings item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
category	string	Required within parent	A string indicating the category of the warning.
context	object	Required within parent	An object providing additional context about the warning, with string properties. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Policy, approvals and errors

SDK function policy ID: hubspot.notes_search_notes. Catalog operation: notes_search_notes. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["crm.objects.contacts.read"]

Official provider source