Home
HubSpot
Engagement Notes Note Search Request Structure
Engagement Notes Note Search Request Structure
Request body for searching notes
Type: object
Properties: 6
Analytics Commerce Content CRM Customer Service Email Marketing Marketing Marketing Automation Operations Sales
NoteSearchRequest is a JSON Structure definition published by HubSpot, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
filterGroups
sorts
query
properties
limit
after
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/engagement-notes-note-search-request-structure.json",
"name": "NoteSearchRequest",
"description": "Request body for searching notes",
"type": "object",
"properties": {
"filterGroups": {
"type": "array",
"description": "Filter groups for the search (OR logic between groups)",
"items": {
"type": "object",
"description": "A group of filters (AND logic within group)",
"properties": {
"filters": {
"type": "array",
"description": "The filters in this group",
"items": {
"$ref": "#/components/schemas/Filter"
},
"example": [
{
"propertyName": "hubspot_owner_id",
"operator": "EQ",
"value": "12345",
"values": [
{}
],
"highValue": "example-value"
}
]
}
}
},
"example": [
{
"filters": [
{}
]
}
]
},
"sorts": {
"type": "array",
"description": "Sort order for results",
"items": {
"type": "object",
"description": "Sort option for search results",
"required": [
"propertyName"
],
"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"
}
}
},
"example": [
{
"propertyName": "hs_timestamp",
"direction": "DESCENDING"
}
]
},
"query": {
"type": "string",
"description": "Full-text search query",
"example": "meeting client"
},
"properties": {
"type": "array",
"description": "Properties to return",
"items": {
"type": "string"
},
"example": [
"example-value"
]
},
"limit": {
"type": "int32",
"description": "Maximum results to return",
"default": 10,
"maximum": 100,
"example": 10
},
"after": {
"type": "string",
"description": "Pagination cursor",
"example": "example-value"
}
}
}