HubSpot: Retrieve stage

← Pipelines operations · Get started

Operation hubspot.pipelines_get_pipeline_stage

Provider route: GET /crm/pipelines/2026-09/{objectType}/{pipelineId}/stages/{stageId}. 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["pipelines"]["getPipelineStage"]>[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.pipelines.getPipelineStage(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.pipelines.get_pipeline_stage(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.objectType	string	Required within parent
path.pipelineId	string	Required within parent
path.stageId	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 Create Stage — response body

Referenced models: Create Stage — response body

Schemas

Create Stage — response body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	A boolean indicating whether the stage is archived.
archivedAt	string	Optional	The date and time when the stage was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when the stage was created, in ISO 8601 format. Format: date-time
displayOrder	JSON	Required within parent
displayOrder (anyOf 1)	integer	Alternative	An integer indicating the position of this stage within the pipeline, determining its order relative to other stages. Format: int32
displayOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	A unique string identifier for the pipeline stage.
label	string	Required within parent	The name or title of the pipeline stage, represented as a string.
metadata	object	Required within parent	An object containing additional metadata for the stage, with string values for each property. Additional keys: see wildcard field
metadata.*	string	Additional keys
updatedAt	string	Required within parent	The date and time when the stage was last updated, in ISO 8601 format. Format: date-time
writePermissions	string	Required within parent	A string indicating the write permissions for the stage. Valid values include 'CRM_PERMISSIONS_ENFORCEMENT', 'READ_ONLY', and 'INTERNAL_ONLY'. Known values: CRM_PERMISSIONS_ENFORCEMENT, INTERNAL_ONLY, READ_ONLY

Policy, approvals and errors

SDK function policy ID: hubspot.pipelines_get_pipeline_stage. Catalog operation: pipelines_get_pipeline_stage. 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: ["automation", "cpq.quotes.read", "cpq.quotes.write", "crm.objects.appointments.read", "crm.objects.appointments.sensitive.read.v2", "crm.objects.appointments.sensitive.write.v2", "crm.objects.appointments.write", "crm.objects.calls.read", "crm.objects.carts.read", "crm.objects.commercepayments.write", "crm.objects.companies.highly_sensitive.read.v2", "crm.objects.companies.highly_sensitive.write.v2", "crm.objects.companies.read", "crm.objects.companies.sensitive.read.v2", "crm.objects.companies.sensitive.write.v2", "crm.objects.companies.write", "crm.objects.contacts.highly_sensitive.read.v2", "crm.objects.contacts.highly_sensitive.write.v2", "crm.objects.contacts.read", "crm.objects.contacts.sensitive.read.v2", "crm.objects.contacts.sensitive.write.v2", "crm.objects.contacts.write", "crm.objects.courses.read", "crm.objects.courses.write", "crm.objects.custom.highly_sensitive.read.v2", "crm.objects.custom.highly_sensitive.write.v2", "crm.objects.custom.read", "crm.objects.custom.sensitive.read.v2", "crm.objects.custom.sensitive.write.v2", "crm.objects.custom.write", "crm.objects.deals.highly_sensitive.read.v2", "crm.objects.deals.highly_sensitive.write.v2", "crm.objects.deals.read", "crm.objects.deals.sensitive.read.v2", "crm.objects.deals.sensitive.write.v2", "crm.objects.deals.write", "crm.objects.emails.read", "crm.objects.feedback_submissions.read", "crm.objects.goals.read", "crm.objects.goals.write", "crm.objects.invoices.read", "crm.objects.invoices.write", "crm.objects.leads.read", "crm.objects.leads.write", "crm.objects.line_items.read", "crm.objects.line_items.write", "crm.objects.listings.read", "crm.objects.listings.write", "crm.objects.marketing_events.read", "crm.objects.marketing_events.write", "crm.objects.meetings.read", "crm.objects.notes.read", "crm.objects.orders.read", "crm.objects.owners.read", "crm.objects.products.write", "crm.objects.projects.highly_sensitive.read", "crm.objects.projects.highly_sensitive.write", "crm.objects.projects.read", "crm.objects.projects.sensitive.read", "crm.objects.projects.sensitive.write", "crm.objects.projects.write", "crm.objects.quotes.read", "crm.objects.quotes.write", "crm.objects.services.read", "crm.objects.services.write", "crm.objects.subscriptions.read", "crm.objects.subscriptions.write", "crm.objects.tasks.read", "crm.objects.tickets.highly_sensitive.read", "crm.objects.tickets.sensitive.read", "crm.objects.users.read", "crm.pipelines.orders.read", "crm.schemas.appointments.read", "crm.schemas.calls.read", "crm.schemas.carts.read", "crm.schemas.commercepayments.read", "crm.schemas.companies.read", "crm.schemas.contacts.read", "crm.schemas.courses.read", "crm.schemas.custom.read", "crm.schemas.deals.read", "crm.schemas.emails.read", "crm.schemas.invoices.read", "crm.schemas.line_items.read", "crm.schemas.listings.read", "crm.schemas.meetings.read", "crm.schemas.notes.read", "crm.schemas.orders.read", "crm.schemas.projects.read", "crm.schemas.quotes.read", "crm.schemas.services.read", "crm.schemas.subscriptions.read", "crm.schemas.tasks.read", "crm.schemas.tickets.read", "e-commerce", "media_bridge.read", "tickets", "tickets.highly_sensitive.v2", "tickets.sensitive.v2", "timeline"]

Official provider source