HubSpot · Schema

FilterGroup

A group of filter conditions combined with AND logic. Use multiple filter groups to create OR conditions between groups.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
filters array An array of filters, all of which must match (AND logic).
View JSON Schema on GitHub

JSON Schema

hubspot-crm-search-filter-group-schema.json Raw ↑
{
  "type": "object",
  "description": "A group of filter conditions combined with AND logic. Use multiple filter groups to create OR conditions between groups.",
  "properties": {
    "filters": {
      "type": "array",
      "description": "An array of filters, all of which must match (AND logic).",
      "example": [
        {
          "propertyName": "Example Record",
          "operator": "EQ",
          "value": "example-value",
          "highValue": "example-value",
          "values": [
            {}
          ]
        }
      ],
      "items": {
        "type": "object",
        "description": "A single filter condition for a CRM object property.",
        "properties": {
          "propertyName": {
            "type": "string",
            "description": "The name of the CRM property to filter on.",
            "example": "Example Record"
          },
          "operator": {
            "type": "string",
            "description": "The comparison operator for the filter.",
            "example": "EQ",
            "enum": [
              "EQ",
              "NEQ",
              "LT",
              "LTE",
              "GT",
              "GTE",
              "BETWEEN",
              "IN",
              "NOT_IN",
              "HAS_PROPERTY",
              "NOT_HAS_PROPERTY",
              "CONTAINS_TOKEN",
              "NOT_CONTAINS_TOKEN"
            ]
          },
          "value": {
            "type": "string",
            "description": "The value to compare against. Not required for HAS_PROPERTY and NOT_HAS_PROPERTY operators.",
            "example": "example-value"
          },
          "highValue": {
            "type": "string",
            "description": "The upper bound value for BETWEEN operator comparisons.",
            "example": "example-value"
          },
          "values": {
            "type": "array",
            "description": "An array of values for IN and NOT_IN operator comparisons.",
            "example": [
              "example-value"
            ],
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "propertyName",
          "operator"
        ]
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "FilterGroup"
}