HubSpot · Schema

Filter

Filter schema from HubSpot Commerce Subscriptions API

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
propertyName string
operator string
value string
View JSON Schema on GitHub

JSON Schema

commerce-subscriptions-api-filter-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/commerce-subscriptions-api-filter-schema.json",
  "title": "Filter",
  "description": "Filter schema from HubSpot Commerce Subscriptions API",
  "type": "object",
  "properties": {
    "propertyName": {
      "type": "string",
      "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"
      ],
      "example": "EQ"
    },
    "value": {
      "type": "string",
      "example": "example-value"
    }
  }
}