HubSpot · Schema

Filter

A single search filter

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name	Type	Description
propertyName	string	The property to filter on
operator	string	The filter operator
value	string	The value to filter by
values	array	Values for IN/NOT_IN operators
highValue	string	High value for BETWEEN operator

View JSON Schema on GitHub

JSON Schema

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