HubSpot · Schema

SortOption

Sort option for search results

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
propertyName string The property to sort by
direction string Sort direction
View JSON Schema on GitHub

JSON Schema

engagement-calls-api-sort-option-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/engagement-calls-api-sort-option-schema.json",
  "title": "SortOption",
  "description": "Sort option for search results",
  "type": "object",
  "properties": {
    "propertyName": {
      "type": "string",
      "description": "The property to sort by",
      "example": "hs_timestamp"
    },
    "direction": {
      "type": "string",
      "enum": [
        "ASCENDING",
        "DESCENDING"
      ],
      "description": "Sort direction",
      "default": "DESCENDING",
      "example": "DESCENDING"
    }
  },
  "required": [
    "propertyName"
  ]
}