HubSpot: Read pipeline limits

HubSpot limitsTracking.getPipelines: arguments, response, policy and SDK examples.

← Limits tracking operations · Get started

Operation hubspot.limits_tracking_get_pipelines

Provider route: GET /crm/limits/2026-09/pipelines. 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["limitsTracking"]["getPipelines"]>[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.limitsTracking.getPipelines(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.limits_tracking.get_pipelines(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed

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 Read pipeline limits — response body

Referenced models: Read pipeline limits — response body

Schemas

Read pipeline limits — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`customObjectTypes`	Model	Required within parent	Expand Read record limits — response body — custom Object Types
`hubspotDefinedObjectTypes`	array	Required within parent	An array of objects representing the limits and usage for HubSpot-defined object types. Each object includes details such as the object type ID, singular and plural labels, limit, usage, and percentage of usage.
`hubspotDefinedObjectTypes[]`	Model	Each item	Expand Read custom property limits — response body — by Object Type item

Referenced models: Read record limits — response body — custom Object Types, Read custom property limits — response body — by Object Type item

Read record limits — response body — custom Object Types

Field	Type	Presence	Description and constraints
`$`	object	Root
`byObjectType`	array	Required within parent	An array containing usage details for each object type, with each entry providing specific usage information for a particular object type.
`byObjectType[]`	Model	Each item	Expand Read calculation property limits — response body — by Object Type item
`overallLimit`	JSON	Required within parent
`overallLimit (anyOf 1)`	integer	Alternative	The maximum number of custom object records allowed. Format: int64
`overallLimit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`overallPercentage`	JSON	Required within parent
`overallPercentage (anyOf 1)`	number	Alternative	The percentage of the overall custom object record limit that has been used.
`overallPercentage (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`overallUsage`	JSON	Required within parent
`overallUsage (anyOf 1)`	integer	Alternative	The total number of custom object records currently in use. Format: int64
`overallUsage (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Read calculation property limits — response body — by Object Type item

Read custom property limits — response body — by Object Type item

Field	Type	Presence	Description and constraints
`$`	object	Root
`limit`	JSON	Required within parent
`limit (anyOf 1)`	integer	Alternative	The maximum allowed count for the object type. Format: int64
`limit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`objectTypeId`	string	Required within parent	The unique identifier for the object type.
`percentage`	JSON	Required within parent
`percentage (anyOf 1)`	number	Alternative	The percentage of the limit that has been used.
`percentage (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`pluralLabel`	string	Required within parent	The plural label for the object type.
`singularLabel`	string	Required within parent	The singular label for the object type.
`usage`	JSON	Required within parent
`usage (anyOf 1)`	integer	Alternative	The current usage count for the object type. Format: int64
`usage (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Read calculation property limits — response body — by Object Type item

Field	Type	Presence	Description and constraints
`$`	object	Root
`objectTypeId`	string	Required within parent	The unique identifier for the object type.
`pluralLabel`	string	Required within parent	The plural form of the label for the object type.
`singularLabel`	string	Required within parent	The singular form of the label for the object type.
`usage`	JSON	Required within parent
`usage (anyOf 1)`	integer	Alternative	The number of records used for the object type. Format: int64
`usage (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: hubspot.limits_tracking_get_pipelines. Catalog operation: limits_tracking_get_pipelines. 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.objects.appointments.read", "crm.objects.appointments.sensitive.read.v2", "crm.objects.appointments.sensitive.write.v2", "crm.objects.appointments.write", "crm.objects.carts.read", "crm.objects.carts.write", "crm.objects.commercepayments.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.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.orders.read", "crm.objects.orders.write", "crm.objects.partner-clients.read", "crm.objects.partner-clients.write", "crm.objects.partner-services.read", "crm.objects.partner-services.write", "crm.objects.products.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.users.read", "crm.objects.users.write", "e-commerce", "media_bridge.read", "tickets", "tickets.highly_sensitive.v2", "tickets.sensitive.v2"]

Official provider source

Report an issue with this page