Skip to main content

Notes

EntityNote

Notes represent free-text annotations attached to any entity in TribeCRM. They can be pinned for visibility and optionally exposed in the support portal.

Use the Note endpoint to query and manage notes. You can also access them via the Notes navigation property on any entity.

Endpoints

List Notes

GET/v1/odata/Note

Single Note

GET/v1/odata/Note({id})

Create Note

POST/v1/odata/Note

Update Note

PUT/v1/odata/Note({id})

Delete Note

DELETE/v1/odata/Note({id})

Fields

Note Fields

FieldTypeDescription
ContentStringNote content (plain text or HTML)
IsPinnedBooleanWhether the note is pinned to the top
IsVisibleInSupportPortalBooleanWhether visible in the support portal

Relationships

RelationshipTarget EntityCardinalityDescription
ProjectMilestoneProjectMilestoneN:1Linked project milestone

Expanding Relationships

GET/v1/odata/Note({id})?$expand=ProjectMilestone
GET/v1/odata/Note({id})/ProjectMilestone

Filtering Examples

GET/v1/odata/Note?$filter=IsPinned eq {IsPinned}&$top={top}
GET/v1/odata/Note?$filter=contains(Content, '{Content}')&$top={top}
GET/v1/odata/Note?$filter=IsVisibleInSupportPortal eq {IsVisibleInSupportPortal}&$top={top}
GET/v1/odata/Note?$filter=CreationDate gt {CreationDate}&$top={top}