Improved

v2 - 2026-03-25 - Unified metadata source for notes and entities

  • Create note Added metadata.source property to specify the external system origin (system, recordId, url) when creating a note
  • Retrieve note Notes now include metadata.source in responses
  • List notes Added metadata[source][system] and metadata[source][recordId] query parameters for filtering by metadata source
  • Search notes Added metadata.source.system and metadata.source.recordId search filters
  • Deprecated the source field (id, origin, recordId, url) in favor of the new unified metadata.source system. The old source field will continue to work but should be migrated to metadata.source
  • Update entity Field value metadata source properties renamed from externalSystemName/externalRecordId to source.system/source.recordId, and added source.url for linking to the external record
  • Retrieve entity, List entities, Search entities Entity field value metadata now uses the unified source.system, source.recordId, and source.url properties in responses