HubSpot: Search — postal Mail search Postal Mail

← Postal mail operations · Get started

Operation hubspot.postal_mail_search_postal_mail

Provider route: POST /crm/objects/2026-09/postal_mail/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["postalMail"]["searchPostalMail"]>[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.postalMail.searchPostalMail(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.postal_mail.search_postal_mail(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 — postal Mail search Postal Mail — request body — body

Referenced models: Search — postal Mail search Postal Mail — 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 — postal Mail search Postal Mail — response body

Referenced models: Search — postal Mail search Postal Mail — response body

Schemas

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

Search — postal Mail search Postal Mail — 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 — postal Mail search Postal Mail — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing a CRM object with basic properties.
results[]	Model	Each item	Expand Merge objects — postal Mail merge — 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 — postal Mail search Postal Mail — response body — paging, Merge objects — postal Mail merge — response body

Search — postal Mail search Postal Mail — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string used as a paging cursor token to retrieve results after a specific point.
filterGroups	array	Required within parent	An array of filter groups used to specify the criteria for filtering CRM objects.
filterGroups[]	Model	Each item	Expand Search — postal Mail search Postal Mail — request body — body filter Groups item
limit	integer	Required within parent	An integer defining the maximum number of results to return. Format: int32
properties	array	Required within parent	An array of strings specifying which properties of the CRM objects should be included in the search results.
properties[]	string	Each item
query	string	Optional	A string representing the search query to be matched against CRM object properties.
sorts	array	Required within parent	An array of strings indicating the properties by which the search results should be sorted.
sorts[]	string	Each item

Referenced models: Search — postal Mail search Postal Mail — request body — body filter Groups item

Search — postal Mail search Postal Mail — 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 — postal Mail get Postal Mail — response body — paging next
prev	Model	Optional	Expand Search — postal Mail search Postal Mail — response body — paging prev

Referenced models: List — postal Mail get Postal Mail — response body — paging next, Search — postal Mail search Postal Mail — response body — paging prev

Merge objects — postal Mail merge — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether the 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	An identifier used to trace the creation or update request of the CRM object.
properties	object	Required within parent	A map of property names to their values, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of their historical values, each entry containing a value and its timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Merge objects — postal Mail merge — 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 representing the URL of the object.
warnings	array	Optional	An array of warnings related to the object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Merge objects — postal Mail merge — response body — warnings item

Referenced models: Merge objects — postal Mail merge — response body — warnings item, Merge objects — postal Mail merge — response body — properties With History value item

Search — postal Mail search Postal Mail — 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 filter objects, each defining a condition to be applied in the search. Each filter includes properties such as 'operator' and 'propertyName' to specify the filtering logic.
filters[]	Model	Each item	Expand Search — postal Mail search Postal Mail — request body — body filter Groups item filters item

Referenced models: Search — postal Mail search Postal Mail — request body — body filter Groups item filters item

List — postal Mail get Postal Mail — 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 token representing the cursor position for fetching the next page of results.
link	string	Optional	A string URL that provides a direct link to the next page of results.

Search — postal Mail search Postal Mail — 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 used to identify the position before the current page in the pagination sequence.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

Merge objects — postal Mail merge — 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 values for each context key. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Merge objects — postal Mail merge — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	A string representing the unique identifier of the source from which the value was obtained.
sourceLabel	string	Optional	A string label providing additional context or description of the source.
sourceType	string	Required within parent	A string indicating the type of source from which the value was obtained.
timestamp	string	Required within parent	The date and time when the value was recorded, in ISO 8601 format. Format: date-time
updatedByUserId	JSON	Optional
updatedByUserId (anyOf 1)	integer	Alternative	The ID of the user who last updated the value, represented as an integer. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	The actual value being tracked, represented as a string.

Policy, approvals and errors

SDK function policy ID: hubspot.postal_mail_search_postal_mail. Catalog operation: postal_mail_search_postal_mail. 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