HubSpot · JSON Structure

Crm Search Api Sort Structure

A sort criterion for ordering search results.

Type: object Properties: 2 Required: 1
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

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

Properties

propertyName direction

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/crm-search-api-sort-structure.json",
  "name": "Sort",
  "description": "A sort criterion for ordering search results.",
  "type": "object",
  "properties": {
    "propertyName": {
      "type": "string",
      "description": "The name of the CRM property to sort by.",
      "example": "Example Record"
    },
    "direction": {
      "type": "string",
      "description": "The sort direction.",
      "enum": [
        "ASCENDING",
        "DESCENDING"
      ],
      "default": "ASCENDING",
      "example": "ASCENDING"
    }
  },
  "required": [
    "propertyName"
  ]
}