> ## Documentation Index > Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a property's validation rules > Leia as regras de validação de uma propriedade identifcada por {propertyName}. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/legacy/v3/crm-property-validations-v3.json GET /crm/v3/property-validations/{objectTypeId}/{propertyName} openapi: 3.0.1 info: title: CRM Property Validations description: Basepom for all HubSpot Projects version: v3 x-hubspot-product-tier-requirements: marketing: FREE sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE x-hubspot-related-documentation: - name: Property validations guide url: https://developers.hubspot.com/docs/guides/api/crm/property-validations servers: - url: https://api.hubapi.com security: [] tags: - name: Basic paths: /crm/v3/property-validations/{objectTypeId}/{propertyName}: get: tags: - Basic summary: Ler regras de validação para uma propriedade description: >- Leia as regras de validação de uma propriedade identifcada por {propertyName}. operationId: >- get-/crm/v3/property-validations/{objectTypeId}/{propertyName}_/crm/v3/property-validations/{objectTypeId}/{propertyName} parameters: - name: objectTypeId in: path description: '' required: true style: simple explode: false schema: type: string - name: propertyName in: path description: '' required: true style: simple explode: false schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: >- #/components/schemas/CollectionResponsePublicPropertyValidationRuleNoPaging default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - crm.objects.owners.read - oauth2: - crm.objects.deals.read - oauth2: - crm.objects.subscriptions.read - oauth2: - crm.objects.services.read - oauth2: - crm.objects.tickets.sensitive.read - oauth2: - crm.objects.listings.write - oauth2: - crm.objects.custom.read - oauth2: - crm.objects.tasks.read - oauth2: - crm.objects.custom.sensitive.write.v2 - oauth2: - crm.objects.custom.highly_sensitive.write.v2 - oauth2: - crm.schemas.quotes.read - oauth2: - crm.objects.companies.read - oauth2: - crm.objects.tickets.highly_sensitive.read - oauth2: - crm.objects.companies.sensitive.read.v2 - oauth2: - media_bridge.read - oauth2: - crm.objects.deals.highly_sensitive.read.v2 - oauth2: - crm.objects.companies.highly_sensitive.read.v2 - oauth2: - crm.objects.contacts.sensitive.write.v2 - oauth2: - crm.objects.calls.read - oauth2: - crm.objects.meetings.read - oauth2: - crm.schemas.services.read - oauth2: - crm.schemas.line_items.read - oauth2: - crm.schemas.subscriptions.read - oauth2: - crm.objects.projects.highly_sensitive.write - oauth2: - crm.schemas.companies.read - oauth2: - crm.objects.products.write - oauth2: - crm.objects.feedback_submissions.read - oauth2: - crm.objects.services.write - oauth2: - crm.objects.subscriptions.write - oauth2: - crm.schemas.calls.read - oauth2: - crm.schemas.meetings.read - oauth2: - crm.objects.contacts.read - oauth2: - crm.objects.invoices.read - oauth2: - crm.schemas.orders.read - oauth2: - crm.schemas.emails.read - oauth2: - crm.schemas.deals.read - oauth2: - crm.objects.deals.write - oauth2: - e-commerce - oauth2: - crm.schemas.notes.read - oauth2: - crm.objects.projects.read - oauth2: - crm.objects.companies.sensitive.write.v2 - oauth2: - crm.objects.custom.highly_sensitive.read.v2 - oauth2: - crm.objects.goals.write - oauth2: - crm.objects.line_items.write - oauth2: - crm.objects.contacts.write - oauth2: - crm.objects.goals.read - oauth2: - crm.objects.line_items.read - oauth2: - crm.objects.projects.sensitive.write - oauth2: - crm.objects.deals.sensitive.read.v2 - oauth2: - crm.objects.quotes.write - oauth2: - crm.schemas.contacts.read - oauth2: - tickets.highly_sensitive.v2 - oauth2: - crm.objects.leads.read - oauth2: - crm.objects.leads.write - oauth2: - crm.schemas.tasks.read - oauth2: - crm.objects.emails.read - oauth2: - crm.schemas.invoices.read - oauth2: - crm.objects.quotes.read - oauth2: - crm.objects.notes.read - oauth2: - crm.objects.courses.read - oauth2: - crm.objects.marketing_events.read - oauth2: - crm.pipelines.orders.read - oauth2: - crm.objects.contacts.sensitive.read.v2 - oauth2: - crm.schemas.projects.read - oauth2: - crm.objects.orders.read - oauth2: - automation - oauth2: - crm.objects.companies.write - oauth2: - crm.schemas.carts.read - oauth2: - cpq.quotes.write - oauth2: - crm.schemas.listings.read - oauth2: - crm.objects.appointments.sensitive.read.v2 - oauth2: - crm.objects.contacts.highly_sensitive.read.v2 - oauth2: - crm.objects.contacts.highly_sensitive.write.v2 - oauth2: - crm.objects.commercepayments.write - oauth2: - crm.objects.invoices.write - oauth2: - crm.objects.custom.sensitive.read.v2 - oauth2: - crm.objects.users.read - oauth2: - crm.objects.appointments.write - oauth2: - crm.objects.deals.sensitive.write.v2 - oauth2: - cpq.quotes.read - oauth2: - crm.objects.appointments.sensitive.write.v2 - oauth2: - crm.objects.projects.highly_sensitive.read - oauth2: - crm.schemas.appointments.read - oauth2: - crm.objects.custom.write - oauth2: - tickets.sensitive.v2 - oauth2: - crm.objects.appointments.read - oauth2: - crm.schemas.courses.read - oauth2: - crm.objects.companies.highly_sensitive.write.v2 - oauth2: - crm.objects.deals.highly_sensitive.write.v2 - oauth2: - crm.objects.projects.sensitive.read - oauth2: - crm.pipelines.approval.read - oauth2: - crm.objects.projects.write - oauth2: - crm.objects.marketing_events.write - oauth2: - crm.schemas.custom.read - oauth2: - crm.objects.carts.read - oauth2: - crm.objects.courses.write - oauth2: - crm.schemas.commercepayments.read - oauth2: - crm.objects.listings.read components: schemas: CollectionResponsePublicPropertyValidationRuleNoPaging: required: - results type: object properties: results: type: array description: >- Conjunto de regras de validação configuradas para a propriedade especificada. Cada regra define uma restrição que os valores da propriedade devem satisfazer (por exemplo, requisitos de formato, limites de comprimento, valores permitidos). items: $ref: '#/components/schemas/PublicPropertyValidationRule' PublicPropertyValidationRule: required: - ruleArguments - ruleType type: object properties: ruleArguments: type: array description: >- Uma lista de argumentos que definem as condições ou parâmetros específicos para a regra de validação. items: type: string ruleType: type: string description: >- A categoria de validação aplicada à propriedade, como FORMAT, ALPHANUMERIC ou MAX_LENGTH. enum: - 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: type: boolean Error: required: - category - correlationId - message type: object properties: category: type: string description: A categoria de erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Um identificador exclusivo para a solicitação. Inclua este valor em relatórios de erro ou tickets de suporte format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: mais informações sobre o erro items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Um mapa de nomes de links para URIs associados que contêm documentação sobre o erro ou as etapas de correção recomendadas message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado example: An error occurred subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa uma resposta de erro retornada pela API quando uma operação falha. Este componente é usado em vários endpoints para fornecer informações detalhadas sobre o erro encontrado. example: message: Invalid input (details will vary based on the error) correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf category: VALIDATION_ERROR links: knowledge-base: https://www.hubspot.com/products/service/knowledge-base ErrorDetail: required: - message type: object properties: code: type: string description: O código de status associado ao detalhe do erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: '{missingScopes=[scope1, scope2]}' in: type: string description: O nome do campo ou parâmetro no qual o erro foi encontrado. message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa informações detalhadas sobre um erro ocorrido na API. Este componente é usado para fornecer contexto e detalhes adicionais sobre os erros, geralmente como parte de uma resposta de erro. responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://app.hubspot.com/oauth/authorize tokenUrl: https://api.hubapi.com/oauth/v1/token scopes: automation: '' cpq.quotes.read: '' cpq.quotes.write: '' crm.objects.appointments.read: '' crm.objects.appointments.sensitive.read.v2: '' crm.objects.appointments.sensitive.write.v2: '' crm.objects.appointments.write: '' crm.objects.calls.read: '' crm.objects.carts.read: '' crm.objects.carts.write: '' 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.emails.read: '' 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.meetings.read: '' crm.objects.notes.read: '' crm.objects.orders.read: '' crm.objects.orders.write: '' 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.tasks.read: '' crm.objects.tickets.highly_sensitive.read: '' crm.objects.tickets.highly_sensitive.write: '' crm.objects.tickets.sensitive.read: '' crm.objects.tickets.sensitive.write: '' crm.objects.users.read: '' crm.objects.users.write: '' crm.pipelines.approval.read: '' crm.pipelines.orders.read: '' crm.pipelines.orders.write: '' crm.schemas.appointments.read: '' crm.schemas.appointments.write: '' crm.schemas.calls.read: '' crm.schemas.calls.write: '' crm.schemas.carts.read: '' crm.schemas.carts.write: '' crm.schemas.commercepayments.read: '' crm.schemas.commercepayments.write: '' crm.schemas.companies.read: '' crm.schemas.companies.write: '' crm.schemas.contacts.read: '' crm.schemas.contacts.write: '' crm.schemas.courses.read: '' crm.schemas.courses.write: '' crm.schemas.custom.read: '' crm.schemas.custom.write: '' crm.schemas.deals.read: '' crm.schemas.deals.write: '' crm.schemas.emails.read: '' crm.schemas.emails.write: '' crm.schemas.invoices.read: '' crm.schemas.invoices.write: '' crm.schemas.line_items.read: '' crm.schemas.listings.read: '' crm.schemas.listings.write: '' crm.schemas.meetings.read: '' crm.schemas.meetings.write: '' crm.schemas.notes.read: '' crm.schemas.notes.write: '' crm.schemas.orders.read: '' crm.schemas.orders.write: '' crm.schemas.projects.read: '' crm.schemas.quotes.read: '' crm.schemas.quotes.write: '' crm.schemas.services.read: '' crm.schemas.services.write: '' crm.schemas.subscriptions.read: '' crm.schemas.subscriptions.write: '' crm.schemas.tasks.read: '' crm.schemas.tasks.write: '' e-commerce: '' media_bridge.read: '' tickets.highly_sensitive.v2: '' tickets.sensitive.v2: '' ````