Skip to main content
GET
Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted.

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

crm.objects.owners.read
crm.objects.deals.read
crm.objects.subscriptions.read
crm.objects.services.read
crm.objects.tickets.sensitive.read
crm.objects.listings.write
crm.objects.custom.read
crm.objects.tasks.read
crm.objects.custom.sensitive.write.v2
crm.objects.custom.highly_sensitive.write.v2
crm.schemas.quotes.read
crm.objects.companies.read
crm.objects.tickets.highly_sensitive.read
crm.objects.companies.sensitive.read.v2
media_bridge.read
crm.objects.deals.highly_sensitive.read.v2
crm.objects.companies.highly_sensitive.read.v2
crm.objects.contacts.sensitive.write.v2
crm.objects.calls.read
crm.objects.meetings.read
crm.schemas.services.read
crm.schemas.line_items.read
crm.schemas.subscriptions.read
crm.objects.projects.highly_sensitive.write
crm.schemas.companies.read
crm.objects.products.write
crm.objects.feedback_submissions.read
crm.objects.services.write
crm.objects.subscriptions.write
crm.schemas.calls.read
crm.schemas.meetings.read
crm.objects.contacts.read
crm.objects.invoices.read
crm.schemas.orders.read
crm.schemas.emails.read
crm.schemas.deals.read
crm.objects.deals.write
e-commerce
crm.schemas.notes.read
crm.objects.projects.read
crm.objects.companies.sensitive.write.v2
crm.objects.custom.highly_sensitive.read.v2
crm.objects.goals.write
crm.objects.line_items.write
crm.objects.contacts.write
crm.objects.goals.read
crm.objects.line_items.read
crm.objects.projects.sensitive.write
crm.objects.deals.sensitive.read.v2
crm.objects.quotes.write
crm.schemas.contacts.read
tickets.highly_sensitive.v2
crm.objects.leads.read
crm.objects.leads.write
crm.schemas.tasks.read
crm.objects.emails.read
crm.schemas.invoices.read
crm.objects.quotes.read
crm.objects.notes.read
crm.objects.courses.read
crm.objects.marketing_events.read
crm.pipelines.orders.read
crm.objects.contacts.sensitive.read.v2
crm.schemas.projects.read
crm.objects.orders.read
automation
crm.objects.companies.write
crm.schemas.carts.read
cpq.quotes.write
crm.schemas.listings.read
crm.objects.appointments.sensitive.read.v2
crm.objects.contacts.highly_sensitive.read.v2
crm.objects.contacts.highly_sensitive.write.v2
crm.objects.commercepayments.write
crm.objects.invoices.write
crm.objects.custom.sensitive.read.v2
crm.objects.users.read
crm.objects.appointments.write
crm.objects.deals.sensitive.write.v2
cpq.quotes.read
crm.objects.appointments.sensitive.write.v2
crm.objects.projects.highly_sensitive.read
crm.schemas.appointments.read
crm.objects.custom.write
tickets.sensitive.v2
crm.objects.appointments.read
crm.schemas.courses.read
crm.objects.companies.highly_sensitive.write.v2
crm.objects.deals.highly_sensitive.write.v2
crm.objects.projects.sensitive.read
crm.pipelines.approval.read
crm.objects.projects.write
crm.objects.marketing_events.write
crm.schemas.custom.read
crm.objects.carts.read
crm.objects.courses.write
crm.schemas.commercepayments.read
crm.objects.listings.read

Path Parameters

objectTypeId
string
required
propertyName
string
required
ruleType
enum<string>
required
Available options:
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

Response

successful operation

ruleArguments
string[]
required

A list of arguments that define the specific conditions or parameters for the validation rule.

ruleType
enum<string>
required

The category of validation applied to the property, such as FORMAT, ALPHANUMERIC, or MAX_LENGTH.

Available options:
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
Last modified on April 9, 2026