HubSpot · Schema
NoteCollectionResponse
A paginated collection of notes
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales
Properties
| Name | Type | Description |
|---|---|---|
| results | array | The list of notes |
| paging | object | Pagination information |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/engagement-notes-note-collection-response-schema.json",
"title": "NoteCollectionResponse",
"description": "A paginated collection of notes",
"type": "object",
"properties": {
"results": {
"type": "array",
"description": "The list of notes",
"items": {
"type": "object",
"description": "Represents a note engagement in the CRM",
"required": [
"id",
"properties",
"createdAt",
"updatedAt",
"archived"
],
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the note",
"example": "1024"
},
"properties": {
"type": "object",
"description": "The note properties",
"additionalProperties": {
"type": "string"
},
"example": {
"hs_note_body": "Met with client to discuss Q1 goals. They are interested in expanding their subscription.",
"hs_timestamp": "2024-01-15T10:30:00.000Z",
"hubspot_owner_id": "12345"
}
},
"propertiesWithHistory": {
"type": "object",
"description": "Properties with their change history",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PropertyHistory"
}
},
"example": {
"key": "value"
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the note was created",
"example": "2024-01-15T10:30:00.000Z"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "When the note was last updated",
"example": "2024-01-15T11:00:00.000Z"
},
"archived": {
"type": "boolean",
"description": "Whether the note is archived",
"example": false
},
"archivedAt": {
"type": "string",
"format": "date-time",
"description": "When the note was archived (if archived)",
"example": "2025-03-15T14:30:00Z"
}
}
},
"example": [
{
"id": "1024",
"properties": {
"hs_note_body": "Met with client to discuss Q1 goals. They are interested in expanding their subscription.",
"hs_timestamp": "2024-01-15T10:30:00.000Z",
"hubspot_owner_id": "12345"
},
"propertiesWithHistory": {
"key": "value"
},
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T11:00:00.000Z",
"archived": false,
"archivedAt": "2025-03-15T14:30:00Z"
}
]
},
"paging": {
"type": "object",
"description": "Pagination information",
"properties": {
"next": {
"type": "object",
"description": "Information about the next page",
"required": [
"after"
],
"properties": {
"after": {
"type": "string",
"description": "Cursor for the next page",
"example": "MTAyNA%3D%3D"
},
"link": {
"type": "string",
"description": "Link to the next page",
"example": "https://app.hubspot.com/contacts/12345"
}
}
}
}
}
},
"required": [
"results"
]
}