Last modified: August 22, 2025
Property validation rules determine formatting requirements for text, date picker, and number properties. For example, an Account ID property that can only include numbers. You can use the property validations API to retrieve validation rules so you’re aware of formatting requirements when setting or updating property values. To complete more actions with properties, refer to the Properties API.

Retrieve all properties with validation rules for an object

To view all properties of an object that have validation rules, make a GET request to /crm/v3/property-validations/{objectTypeId}. Refer to this guide for a full list of objectTypeId values. Properties with validation rules are returned with the following fields:
  • propertyName: the name of the property with validation rules.
  • propertyValidationRules: an array with the rules set for the property. Includes each rule’s ruleType (the category for the rule) and ruleArguments (specific requirements of the rule).
For example, to request contact properties with validation rules, make a GET request to /crm/v3/property-validations/0-1. In the following response, there are two properties with rules, the zip (Postal Code) property which only allows numeric characters and the age property which requires a minimum value of 1.
{
  "results": [
    {
      "propertyName": "zip",
      "propertyValidationRules": [
        {
          "ruleType": "ALPHANUMERIC",
          "ruleArguments": ["NUMERIC_ONLY"]
        }
      ]
    },
    {
      "propertyName": "age",
      "propertyValidationRules": [
        {
          "ruleType": "MIN_NUMBER",
          "ruleArguments": ["1"]
        }
      ]
    }
  ]
}

Retrieve validation rules for a property

To view the validation rules set for a specific property, make a GET request to /crm/v3/property-validations/{objectTypeId}/{propertyName}. You can refer to this guide for a full list of objectTypeId values and use the Properties API to retrieve propertyName values. The property’s rules are returned with the ruleType and ruleArguments for each. For example, to view validation rules for an Order ID deal property, make a GET request to /crm/v3/property-validations/0-3/order_id. In the following response, the property has three rules that require the value to contain between one and eight numeric characters.
{
  "results": [
    {
      "ruleType": "ALPHANUMERIC",
      "ruleArguments": ["NUMERIC_ONLY"]
    },
    {
      "ruleType": "MAX_LENGTH",
      "ruleArguments": ["10"]
    },
    {
      "ruleType": "MIN_LENGTH",
      "ruleArguments": ["1"]
    }
  ]
}