HubSpot: Read all property groups

← Properties operations · Get started

Operation hubspot.properties_property_groups_get_properties

Provider route: GET /crm/properties/2026-09/{objectType}/groups. 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["properties"]["propertyGroupsGetProperties"]>[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.properties.propertyGroupsGetProperties(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.properties.property_groups_get_properties(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
query	object	Optional	Additional keys: not allowed
query.locale	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 Read all property groups — response body

Referenced models: Read all property groups — response body

Schemas

Read all property groups — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of property groups, where each group is represented by a PropertyGroup object.
results[]	Model	Each item	Expand Read a property group — response body

Referenced models: Read a property group — response body

Read a property group — response body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	Indicates whether the property group is archived.
displayOrder	JSON	Optional
displayOrder (anyOf 1)	integer	Alternative	Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values. Format: int32
displayOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
label	string	Required within parent	A human-readable label that will be shown in HubSpot.
name	string	Required within parent	The internal property group name, which must be used when referencing the property group via the API.

Policy, approvals and errors

SDK function policy ID: hubspot.properties_property_groups_get_properties. Catalog operation: properties_property_groups_get_properties. 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", "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.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.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.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.users.read", "crm.pipelines.orders.read", "crm.schemas.appointments.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.invoices.read", "crm.schemas.line_items.read", "crm.schemas.listings.read", "crm.schemas.orders.read", "crm.schemas.projects.read", "crm.schemas.quotes.read", "crm.schemas.services.read", "crm.schemas.subscriptions.read", "e-commerce", "media_bridge.read", "tickets", "tickets.highly_sensitive.v2", "tickets.sensitive.v2", "timeline"]

Official provider source