HubSpot · Schema

Filter

A single filter criterion

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name	Type	Description
propertyName	string	The property to filter on
operator	string	The comparison operator
value	string	The value to compare against
values	array	Values for IN/NOT_IN operators
highValue	string	Upper bound for BETWEEN operator

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "description": "A single filter criterion",
  "properties": {
    "propertyName": {
      "type": "string",
      "description": "The property to filter on",
      "example": "Example Record"
    },
    "operator": {
      "type": "string",
      "description": "The comparison operator",
      "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",
      "example": "example-value"
    },
    "values": {
      "type": "array",
      "description": "Values for IN/NOT_IN operators",
      "example": [
        "example-value"
      ],
      "items": {
        "type": "string"
      }
    },
    "highValue": {
      "type": "string",
      "description": "Upper bound for BETWEEN operator",
      "example": "example-value"
    }
  },
  "required": [
    "propertyName",
    "operator"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Filter"
}