HubSpot · Schema

Sort

A sort criterion for ordering search results.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
propertyName string The name of the CRM property to sort by.
direction string The sort direction.
View JSON Schema on GitHub

JSON Schema

hubspot-crm-search-sort-schema.json Raw ↑ 
{
  "type": "object",
  "description": "A sort criterion for ordering search results.",
  "properties": {
    "propertyName": {
      "type": "string",
      "description": "The name of the CRM property to sort by.",
      "example": "Example Record"
    },
    "direction": {
      "type": "string",
      "description": "The sort direction.",
      "example": "ASCENDING",
      "enum": [
        "ASCENDING",
        "DESCENDING"
      ]
    }
  },
  "required": [
    "propertyName"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Sort"
}