HubSpot: List — communications get Communications

← Communications operations · Get started

Operation hubspot.communications_get_communications

Provider route: GET /crm/objects/2026-09/communications. 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["communications"]["getCommunications"]>[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.communications.getCommunications(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.communications.get_communications(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 — communications get Communications — response body

Referenced models: List — communications get Communications — response body

Schemas

List — communications get Communications — 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 — communications get Communications — response body — paging
results	array	Required within parent	An array of simple public objects with associations. Each object includes its properties and associated data.
results[]	Model	Each item	Expand Read — communications get Communication — response body

Referenced models: List — communications get Communications — response body — paging, Read — communications get Communication — response body

List — communications get Communications — 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 — communications get Communications — response body — paging next

Referenced models: List — communications get Communications — response body — paging next

Read — communications get Communication — 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 the CRM object is archived.
archivedAt	string	Optional	The date and time when the CRM object was archived, in ISO 8601 format. Format: date-time
associations	object	Optional	A map of associated object types to their respective associated IDs. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — communications get Communication — response body — associations value
createdAt	string	Required within parent	The date and time when the CRM object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the CRM object.
objectWriteTraceId	string	Optional	A string identifier used for tracing writes to the CRM object.
properties	object	Required within parent	A map of property names to their current values for the CRM object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of historical values, each with a timestamp, for the CRM object. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Merge objects — communications merge — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when the CRM object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL for accessing the CRM object.
warnings	array	Optional	An array of warnings related to the CRM object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Merge objects — communications merge — response body — warnings item

Referenced models: Read — communications get Communication — response body — associations value, Merge objects — communications merge — response body — warnings item, Merge objects — communications merge — response body — properties With History value item

List — communications get Communications — 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 after the last item on the current page, used to fetch the next page of results.
link	string	Optional	A string URL that provides a direct link to the next page of results.

Read — communications get Communication — 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 — communications search Communications — 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 — products get Product — response body — associations value results item

Referenced models: Read — products get Product — response body — associations value results item, Search — communications search Communications — response body — paging

Merge objects — communications 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 containing 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, providing details about the issue.

Merge objects — communications 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.
sourceLabel	string	Optional	A string providing a human-readable label for the source.
sourceType	string	Required within parent	A string indicating the type of source from which the value originated.
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	An integer representing the ID of the user who last updated the value. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	A string representing the value at the given timestamp.

Read — products get Product — 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 associated object. It is a string.
type	string	Required within parent	The type of the associated object. It is a string.

Search — communications search Communications — 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 — communications get Communications — response body — paging next
prev	Model	Optional	Expand Search for quotes using specified criteria — response body — paging prev

Referenced models: List — communications get Communications — response body — paging next, Search for quotes using specified criteria — response body — paging prev

Search for quotes 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 representing the cursor token used to access the previous page of results.
link	string	Optional	A string containing the URL link to the previous page of results.

Policy, approvals and errors

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