HubSpot · JSON Structure

Commerce Payments Api Filter Group Structure

A group of filters combined with AND logic

Type: object Properties: 1 Required: 1

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

FilterGroup is a JSON Structure definition published by HubSpot, describing 1 property, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

filters

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/commerce-payments-api-filter-group-structure.json",
  "name": "FilterGroup",
  "description": "A group of filters combined with AND logic",
  "type": "object",
  "properties": {
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A single filter criterion",
        "required": [
          "propertyName",
          "operator"
        ],
        "properties": {
          "propertyName": {
            "type": "string",
            "description": "The property to filter on",
            "example": "Example Record"
          },
          "operator": {
            "type": "string",
            "enum": [
              "EQ",
              "NEQ",
              "LT",
              "LTE",
              "GT",
              "GTE",
              "BETWEEN",
              "IN",
              "NOT_IN",
              "HAS_PROPERTY",
              "NOT_HAS_PROPERTY",
              "CONTAINS_TOKEN",
              "NOT_CONTAINS_TOKEN"
            ],
            "description": "The comparison operator",
            "example": "EQ"
          },
          "value": {
            "type": "string",
            "description": "The value to compare against",
            "example": "example-value"
          },
          "values": {
            "type": "array",
            "description": "Values for IN/NOT_IN operators",
            "items": {
              "type": "string"
            },
            "example": [
              "example-value"
            ]
          },
          "highValue": {
            "type": "string",
            "description": "Upper bound for BETWEEN operator",
            "example": "example-value"
          }
        }
      },
      "example": [
        {
          "propertyName": "Example Record",
          "operator": "EQ",
          "value": "example-value",
          "values": [
            {}
          ],
          "highValue": "example-value"
        }
      ]
    }
  },
  "required": [
    "filters"
  ]
}