HubSpot · Schema
NoteSearchRequest
Request body for searching notes
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales
Properties
| Name | Type | Description |
|---|---|---|
| filterGroups | array | Filter groups for the search (OR logic between groups) |
| sorts | array | Sort order for results |
| query | string | Full-text search query |
| properties | array | Properties to return |
| limit | integer | Maximum results to return |
| after | string | Pagination cursor |
JSON Schema
{
"type": "object",
"description": "Request body for searching notes",
"properties": {
"filterGroups": {
"type": "array",
"description": "Filter groups for the search (OR logic between groups)",
"example": [
{
"filters": [
{}
]
}
],
"items": {
"type": "object",
"description": "A group of filters (AND logic within group)",
"properties": {
"filters": {
"type": "array",
"description": "The filters in this group",
"example": [
{
"propertyName": "hubspot_owner_id",
"operator": "EQ",
"value": "12345",
"values": [
{}
],
"highValue": "example-value"
}
],
"items": {
"type": "object",
"description": "A single search filter",
"properties": {
"propertyName": {
"type": "string",
"description": "The property to filter on",
"example": "hubspot_owner_id"
},
"operator": {
"type": "string",
"description": "The filter operator",
"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",
"description": "The value to filter by",
"example": "12345"
},
"values": {
"type": "array",
"description": "Values for IN/NOT_IN operators",
"example": [
"example-value"
],
"items": {
"type": "object"
}
},
"highValue": {
"type": "string",
"description": "High value for BETWEEN operator",
"example": "example-value"
}
},
"required": [
"propertyName",
"operator"
]
}
}
}
}
},
"sorts": {
"type": "array",
"description": "Sort order for results",
"example": [
{
"propertyName": "hs_timestamp",
"direction": "DESCENDING"
}
],
"items": {
"type": "object",
"description": "Sort option for search results",
"properties": {
"propertyName": {
"type": "string",
"description": "The property to sort by",
"example": "hs_timestamp"
},
"direction": {
"type": "string",
"description": "Sort direction",
"example": "DESCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
]
}
},
"required": [
"propertyName"
]
}
},
"query": {
"type": "string",
"description": "Full-text search query",
"example": "meeting client"
},
"properties": {
"type": "array",
"description": "Properties to return",
"example": [
"example-value"
],
"items": {
"type": "string"
}
},
"limit": {
"type": "integer",
"description": "Maximum results to return",
"example": 10
},
"after": {
"type": "string",
"description": "Pagination cursor",
"example": "example-value"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "NoteSearchRequest"
}