HubSpot: Batch read actors

← Conversations operations · Get started

Operation hubspot.conversations_get_actors

Provider route: POST /conversations/conversations/2026-09/actors/batch/read. 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["conversations"]["getActors"]>[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.conversations.getActors(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.conversations.get_actors(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.property	string	Optional
body	Model	Required within parent	Expand Batch read actors — request body — body

Referenced models: Batch read actors — 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
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Actor
$ (anyOf 2)	Model	Alternative	Expand Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Actor With Errors

Referenced models: Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Actor, Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Actor With Errors

Schemas

4 more schemas are linked from the tables above, on the schema pages.

Batch read actors — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of strings that are required for the batch operation. Each item in the array is a string.
inputs[]	string	Each item

Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Actor

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to their corresponding URIs, which may provide additional information or resources related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of PublicActor objects representing the results of the batch operation.
results[]	Model	Each item	Expand Retrieve actor — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Retrieve actor — response body

Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Actor With Errors

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of StandardError objects detailing any errors encountered during the batch operation.
errors[]	Model	Each item	Expand Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	An object containing key-value pairs of link names to their associated URIs. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of PublicActor objects representing the results of the batch operation.
results[]	Model	Each item	Expand Retrieve actor — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Retrieve actor — response body

Retrieve actor — response body

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Retrieve actor — response body — type: AGENT
$ (anyOf 2)	Model	Alternative	Expand Retrieve actor — response body — type: BOT
$ (anyOf 3)	Model	Alternative	Expand Retrieve actor — response body — type: INTEGRATOR
$ (anyOf 4)	Model	Alternative	Expand Retrieve actor — response body — type: SYSTEM
$ (anyOf 5)	Model	Alternative	Expand Retrieve actor — response body — type: VISITOR
$ (anyOf 6)	Model	Alternative	Expand Retrieve actor — response body — type: EMAIL
$ (anyOf 7)	Model	Alternative	Expand Retrieve actor — response body — type: LLM

Referenced models: Retrieve actor — response body — type: AGENT, Retrieve actor — response body — type: BOT, Retrieve actor — response body — type: EMAIL, Retrieve actor — response body — type: INTEGRATOR, Retrieve actor — response body — type: LLM, Retrieve actor — response body — type: SYSTEM, Retrieve actor — response body — type: VISITOR

Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	A string indicating the category of the error.
context	object	Required within parent	An object containing additional context about the error condition, with properties as arrays of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects, providing further information about the error.
errors[]	Model	Each item	Expand Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item
id	string	Optional	A string representing the unique identifier for the error.
links	object	Required within parent	An object mapping link names to associated URIs with documentation about the error or recommended remediation steps. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing the error message.
status	string	Required within parent	The status of the error as a string.
subCategory	object	Optional	An object providing more specific details about the error category.

Referenced models: Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item

Retrieve actor — response body — type: AGENT

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	A string representing the URL to the avatar image of the agent.
email	string	Optional	A string containing the email address of the agent.
id	string	Required within parent	A string that uniquely identifies the agent actor.
name	string	Optional	A string representing the name of the agent.
type	string	Required within parent	A string representing the type of actor, which is always 'AGENT' for this component. Known values: AGENT Default: AGENT

Retrieve actor — response body — type: BOT

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	A string representing the URL of the avatar image for the bot actor.
id	string	Required within parent	A string representing the unique identifier for the bot actor.
name	string	Optional	A string representing the name of the bot actor.
type	string	Required within parent	A string indicating the type of actor, which is always 'BOT' for this component. Known values: BOT Default: BOT

Retrieve actor — response body — type: EMAIL

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	A string containing the email address associated with the actor.
id	string	Required within parent	A string that uniquely identifies the email actor.
type	string	Required within parent	A string representing the type of actor, which defaults to 'EMAIL'. Known values: EMAIL Default: EMAIL

Retrieve actor — response body — type: INTEGRATOR

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	A string containing the URL or identifier for the avatar image of the integrator actor.
id	string	Required within parent	A string that uniquely identifies the integrator actor.
name	string	Required within parent	A string representing the name of the integrator actor.
type	string	Required within parent	A string representing the type of actor, with the default value 'INTEGRATOR'. Known values: INTEGRATOR Default: INTEGRATOR

Policy, approvals and errors

SDK function policy ID: hubspot.conversations_get_actors. Catalog operation: conversations_get_actors. 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: ["conversations.read"]

Official provider source