HubSpot: Retrieve permissions

← Pipeline governance operations · Get started

Operation hubspot.pipeline_governance_get_pipeline_stage_permissions

Provider route: GET /crm/pipelines-rules/2026-09/{objectTypeId}/{pipelineId}/stage-edit-permissions. 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"]["getPipelineStagePermissions"]>[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.getPipelineStagePermissions(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_stage_permissions(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.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 Update permissions — response body

Referenced models: Update permissions — response body

Schemas

Update permissions — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when these permissions were created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this set of pipeline stage permissions.
objectTypeId	string	Required within parent	The identifier for the type of object associated with these permissions.
pipelineId	string	Required within parent	The unique identifier for the pipeline to which these stage permissions apply.
stages	array	Required within parent	An array of stage permissions, each defining access rules for a specific stage within the pipeline.
stages[]	Model	Each item	Expand Update permissions — response body — stages item
updatedAt	string	Required within parent	The date and time when these permissions were last updated, in ISO 8601 format. Format: date-time

Referenced models: Update permissions — response body — stages item

Update permissions — response body — stages item

Field	Type	Presence	Description and constraints
$	object	Root
label	string	Required within parent	A descriptive label for the stage, used for display purposes. It is a string that helps identify the stage's purpose or function.
permissionMode	string	Required within parent	Defines the mode of permission for the stage. It is a string that can be either 'OPEN' or 'RESTRICTED', indicating whether the stage is accessible to all users or restricted to certain users or teams. Known values: OPEN, RESTRICTED
pipelineStageId	string	Required within parent	The unique identifier for the pipeline stage. It is a string that distinguishes this stage from others within the pipeline.
superAdmin	boolean	Required within parent	A boolean value indicating whether super administrators have access to this stage. If true, super admins can access the stage regardless of other permissions.
teamIds	array	Required within parent	An array of strings representing the IDs of teams that have access to this stage. This property is used to specify which teams are allowed to interact with the stage.
teamIds[]	string	Each item
userIds	array	Required within parent	An array of strings representing the IDs of individual users who have access to this stage. This property allows for specifying user-level access control.
userIds[]	string	Each item

Policy, approvals and errors

SDK function policy ID: hubspot.pipeline_governance_get_pipeline_stage_permissions. Catalog operation: pipeline_governance_get_pipeline_stage_permissions. 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-pipelines-locked-stages-access", "pipeline-level-permissions-access"]

Official provider source