HubSpot: List — postal Mail get Postal Mail

← Postal mail operations · Get started

Operation hubspot.postal_mail_get_postal_mail

Provider route: GET /crm/objects/2026-09/postal_mail. 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"]["getPostalMail"]>[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.getPostalMail(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.get_postal_mail(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.after	string	Optional
query.archived	boolean	Optional	Default: false
query.associations	array	Optional
query.associations[]	string	Each item
query.limit	integer	Optional	Default: 10 Format: int32
query.properties	array	Optional
query.properties[]	string	Each item
query.propertiesWithHistory	array	Optional
query.propertiesWithHistory[]	string	Each item

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 List — postal Mail get Postal Mail — response body

Referenced models: List — postal Mail get Postal Mail — response body

Schemas

List — postal Mail get Postal Mail — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API.
paging	Model	Optional	Expand List — postal Mail get Postal Mail — response body — paging
results	array	Required within parent	An array of SimplePublicObjectWithAssociations, each representing a CRM object with its properties and associated data.
results[]	Model	Each item	Expand Read — postal Mail get Postal Mail Objectid — response body

Referenced models: List — postal Mail get Postal Mail — response body — paging, Read — postal Mail get Postal Mail Objectid — response body

List — postal Mail get Postal Mail — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand List — postal Mail get Postal Mail — response body — paging next

Referenced models: List — postal Mail get Postal Mail — response body — paging next

Read — postal Mail get Postal Mail Objectid — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.
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
associations	object	Optional	A map of associated object types to their associated IDs. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — postal Mail get Postal Mail Objectid — response body — associations value
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.
objectWriteTraceId	string	Optional	An identifier used for tracing the write operations on this object.
properties	object	Required within parent	A map of the object's property names to their current values. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of the object's property names to their values, including historical data with timestamps. 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	The URL link to access this object.
warnings	array	Optional	A list of warnings associated with this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Merge objects — postal Mail merge — response body — warnings item

Referenced models: Read — postal Mail get Postal Mail Objectid — response body — associations value, Merge objects — postal Mail merge — response body — warnings item, Merge objects — postal Mail merge — response body — properties With History value 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.

Read — postal Mail get Postal Mail Objectid — response body — associations value

Field	Type	Presence	Description and constraints
$	object	Root	Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results.
paging	Model	Optional	Expand Search — postal Mail search Postal Mail — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an AssociatedId object. This property is required.
results[]	Model	Each item	Expand Read — postal Mail get Postal Mail Objectid — response body — associations value results item

Referenced models: Read — postal Mail get Postal Mail Objectid — response body — associations value results item, Search — postal Mail search Postal Mail — response body — paging

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.

Read — postal Mail get Postal Mail Objectid — response body — associations value results item

Field	Type	Presence	Description and constraints
$	object	Root	Contains the id and type of an association
id	string	Required within parent	The unique identifier for the association. It is a string that distinguishes this association from others.
type	string	Required within parent	The type of association, represented as a string. This indicates the nature or category of the relationship between the associated objects.

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

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.

Policy, approvals and errors

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