Notes
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/NoteSingle Note
GET
/v1/odata/Note({id})Create Note
POST
/v1/odata/NoteUpdate Note
PUT
/v1/odata/Note({id})Delete Note
DELETE
/v1/odata/Note({id})Fields
Note Fields
| Field | Type | Description |
|---|---|---|
Content | String | Note content (plain text or HTML) |
IsPinned | Boolean | Whether the note is pinned to the top |
IsVisibleInSupportPortal | Boolean | Whether visible in the support portal |
Relationships
| Relationship | Target Entity | Cardinality | Description |
|---|---|---|---|
| ProjectMilestone | ProjectMilestone | N:1 | Linked project milestone |
Expanding Relationships
GET
/v1/odata/Note({id})?$expand=ProjectMilestoneNavigating Relationships
GET
/v1/odata/Note({id})/ProjectMilestoneFiltering 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}