HubSpot: Retrieve actor

← Conversations operations · Get started

Operation hubspot.conversations_get_actor

Provider route: GET /conversations/conversations/2026-09/actors/{actorId}. 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"]["getActor"]>[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.getActor(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_actor(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.actorId	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.property	string	Optional

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 Retrieve actor — response body

Referenced models: Retrieve actor — response body

Schemas

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

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

Retrieve actor — response body — type: LLM

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

Retrieve actor — response body — type: SYSTEM

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	A string that uniquely identifies the system actor.
type	string	Required within parent	A string that specifies the type of actor, which is 'SYSTEM' for this component. Known values: SYSTEM Default: SYSTEM

Retrieve actor — response body — type: VISITOR

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

Policy, approvals and errors

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