HubSpot · Schema

SearchRequest

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name	Type	Description
filterGroups	array
sorts	array
query	string
properties	array
limit	integer
after	string

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "properties": {
    "filterGroups": {
      "type": "array",
      "example": [
        {
          "filters": [
            {}
          ]
        }
      ],
      "items": {
        "type": "object",
        "properties": {
          "filters": {
            "type": "array",
            "example": [
              {
                "propertyName": "Example Record",
                "operator": "EQ",
                "value": "example-value"
              }
            ],
            "items": {
              "type": "object",
              "properties": {
                "propertyName": {
                  "type": "string",
                  "example": "Example Record"
                },
                "operator": {
                  "type": "string",
                  "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",
                  "example": "example-value"
                }
              }
            }
          }
        }
      }
    },
    "sorts": {
      "type": "array",
      "example": [
        {
          "propertyName": "Example Record",
          "direction": "ASCENDING"
        }
      ],
      "items": {
        "type": "object",
        "properties": {
          "propertyName": {
            "type": "string"
          },
          "direction": {
            "type": "string",
            "enum": [
              "ASCENDING",
              "DESCENDING"
            ]
          }
        }
      }
    },
    "query": {
      "type": "string",
      "example": "example-value"
    },
    "properties": {
      "type": "array",
      "example": [
        "example-value"
      ],
      "items": {
        "type": "string"
      }
    },
    "limit": {
      "type": "integer",
      "example": 100
    },
    "after": {
      "type": "string",
      "example": "example-value"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "SearchRequest"
}