HubSpot: Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted

← Property validations operations · Get started

Operation hubspot.property_validations_get_property_validations_ruletype

Provider route: GET /crm/property-validations/2026-09/{objectTypeId}/{propertyName}/rule-type/{ruleType}. 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["propertyValidations"]["getPropertyValidationsRuletype"]>[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.propertyValidations.getPropertyValidationsRuletype(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.property_validations.get_property_validations_ruletype(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	Model	Required within parent	Expand Update a validation rule for a specific property and rule type, allowing customization of property value constraints — request body — path

Referenced models: Update a validation rule for a specific property and rule type, allowing customization of property value constraints — request body — path

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 Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted — response body

Referenced models: Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted — response body

Schemas

Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted — response body

Field	Type	Presence	Description and constraints
$	object	Root
ruleArguments	array	Required within parent	A list of arguments that define the specific conditions or parameters for the validation rule.
ruleArguments[]	string	Each item
ruleType	string	Required within parent	The category of validation applied to the property, such as FORMAT, ALPHANUMERIC, or MAX_LENGTH. Known values: AFTER_DATETIME_DURATION, AFTER_DURATION, ALPHANUMERIC, BEFORE_DATETIME_DURATION, BEFORE_DURATION, DAYS_OF_WEEK, DECIMAL, DOMAIN, EMAIL, EMAIL_ALLOWED_DOMAINS, EMAIL_BLOCKED_DOMAINS, END_DATE, END_DATETIME, FORMAT, MAX_LENGTH, MAX_NUMBER, MIN_LENGTH, MIN_NUMBER, PHONE_NUMBER_WITH_EXPLICIT_COUNTRY_CODE, REGEX, SPECIAL_CHARACTERS, START_DATE, START_DATETIME, URL, URL_ALLOWED_DOMAINS, URL_BLOCKED_DOMAINS, WHITESPACE
shouldApplyNormalization	boolean	Optional	A boolean indicating whether normalization should be applied to the property value before validation.

Update a validation rule for a specific property and rule type, allowing customization of property value constraints — request body — path

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
objectTypeId	string	Required within parent
propertyName	string	Required within parent
ruleType	string	Required within parent	One of: AFTER_DATETIME_DURATION, AFTER_DURATION, ALPHANUMERIC, BEFORE_DATETIME_DURATION, BEFORE_DURATION, DAYS_OF_WEEK, DECIMAL, DOMAIN, EMAIL, EMAIL_ALLOWED_DOMAINS, EMAIL_BLOCKED_DOMAINS, END_DATE, END_DATETIME, FORMAT, MAX_LENGTH, MAX_NUMBER, MIN_LENGTH, MIN_NUMBER, PHONE_NUMBER_WITH_EXPLICIT_COUNTRY_CODE, REGEX, SPECIAL_CHARACTERS, START_DATE, START_DATETIME, URL, URL_ALLOWED_DOMAINS, URL_BLOCKED_DOMAINS, WHITESPACE

Policy, approvals and errors

SDK function policy ID: hubspot.property_validations_get_property_validations_ruletype. Catalog operation: property_validations_get_property_validations_ruletype. 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