Skip to main content
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.
  • 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.

createdAt string The date this item was created in RFC3339 format. updatedAt string The date this item was updated 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.
Example Notes Object