Notes

This resource represents a note on a client or a company in your workspace. Each client or company can have many notes.

Properties

content string
The content contained within the note. It must be valid HTML so that it renders correctly in our UI. We support most of the basic HTML tags for formatting.

Some basic formatting notes:

• Currently we only support the <h2> and <h3> heading tags.
• A single line in a note can be represented as either a line of text or text wrapped in a <p> tag.
  JSON

  {
      "content": "Single line of content.",
  }
  // or
  {
      "content": "<p>Single line of content.</p>",
  }
  

• To add a new line within content, you can either add a <br> tag to mark the new line or wrap each line in a separate <p> tag.
  JSON

  {
      "content": "<p>Line 1</p><p>Line 2</p>",
  }
  // or
  {
      "content": "<p>Line1<br/>Line2</p>",
  }
  

createdAt string
The date this item was created in RFC3339 format.

creatorId string
The ID of the user that created this item.

entityId string
The ID of the entity (client or company) that this note is associated with. Based on entityType. This value will represent the id of different resources.

entityType string
The type of entity that this note is associated with. Can be one of client or company.

id string
The unique identifier for this item.

object string
The object type of this resource.

title string
The title of this note. This field does not support formatting or newlines.

{
    "content": "<p>Example note content.</p>",
    "createdAt": "2025-03-11T20:29:14Z",
    "creatorId": "2417c06f-44fe-4913-8c84-cd5d358d6f4b",
    "entityId": "9edc4eb8-2b52-454a-bacf-c1d3889a1fbd",
    "entityType": "company",
    "id": "20a7d78e-9bd1-4b76-a763-bb29603542a4",
    "object": "note",
    "title": "Example Note"
}