HubSpot · Schema

Note

Represents a note engagement in the CRM

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name	Type	Description
id	string	The unique identifier for the note
properties	object	The note properties
propertiesWithHistory	object	Properties with their change history
createdAt	string	When the note was created
updatedAt	string	When the note was last updated
archived	boolean	Whether the note is archived
archivedAt	string	When the note was archived (if archived)

View JSON Schema on GitHub

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-schema.json",
  "title": "Note",
  "description": "Represents a note engagement in the CRM",
  "type": "object",
  "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": {
          "type": "object",
          "description": "Historical value of a property",
          "properties": {
            "value": {
              "type": "string",
              "description": "The historical value",
              "example": "Initial meeting notes"
            },
            "timestamp": {
              "type": "string",
              "format": "date-time",
              "description": "When the value was set",
              "example": "2024-01-15T10:30:00.000Z"
            },
            "sourceType": {
              "type": "string",
              "description": "The source type that set this value",
              "example": "CRM_UI"
            },
            "sourceId": {
              "type": "string",
              "description": "The source identifier",
              "example": "userId:12345"
            },
            "sourceLabel": {
              "type": "string",
              "description": "Human-readable source label",
              "example": "John Doe"
            },
            "updatedByUserId": {
              "type": "integer",
              "description": "The user ID who made the change",
              "example": 12345
            }
          }
        }
      },
      "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"
    }
  },
  "required": [
    "id",
    "properties",
    "createdAt",
    "updatedAt",
    "archived"
  ]
}