HubSpot: Retrieve Approval

← Pipeline governance operations · Get started

Operation hubspot.pipeline_governance_get_pipeline_approvals

Provider route: GET /crm/pipelines-rules/2026-09/{objectTypeId}/{pipelineId}/approvals/{objectId}. 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["pipelineGovernance"]["getPipelineApprovals"]>[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.pipelineGovernance.getPipelineApprovals(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.pipeline_governance.get_pipeline_approvals(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.objectId	integer	Required within parent	Format: int64
path.objectTypeId	string	Required within parent
path.pipelineId	string	Required within parent

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 Start Approval — response body

Referenced models: Start Approval — response body

Schemas

Start Approval — response body

Field	Type	Presence	Description and constraints
$	object	Root
approvalId	string	Optional	The unique identifier for the approval process instance associated with this object.
approvalStatus	string	Required within parent	The current approval status of the object. This indicates whether the object is approved, pending approval, or rejected. Known values: APPROVED, NO_APPROVAL_NEEDED, NOT_APPLICABLE, PENDING, REJECTED
createdAt	string	Required within parent	The date and time when this approval status record was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this approval status object.
objectId	string	Required within parent	The unique identifier of the object whose approval status is being tracked.
objectTypeId	string	Required within parent	The type identifier of the object, indicating what kind of object is being approved.
pipelineId	string	Required within parent	The unique identifier of the pipeline in which the object is located.
pipelineStageId	string	Required within parent	The unique identifier of the pipeline stage where the object currently resides.
updatedAt	string	Required within parent	The date and time when this approval status record was last updated, in ISO 8601 format. Format: date-time

Policy, approvals and errors

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

Official provider source