Get details for a specific note
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
A note is a text document that can be linked to other major objects. Unlike the details fields that are available on the other major objects such as contacts, notes do not impose a length limit and are suitable for large blobs of text or data that needs to be stored and linked to a major object.
As with the other major objects, notes can be categorized, tagged with keywords, and associated with groups and source lists.
Attributes
| Name | Type | Description | Attributes |
|---|---|---|---|
self | reference | URL of the note | Read-only Non-null |
title | string | Subject line of the note, suitable for indexing and later search/display | Read-Write Non-null |
details | string | Contents of the note | Read-Write Non-null |
category | string | Category name | Read-Write Nullable |
keywords | array of string | List of Keywords | Read-Write Nullable |
appointments | reference | List of Appointments | Read-Write Nullable |
contacts | reference | List of Contacts | Read-Write Nullable |
companies | reference | List of Companies | Read-Write Nullable |
groups | reference | List of Groups | Read-Write Nullable |
forms | reference | List of Forms | Read-Write\ Nullable |
opportunities | reference | List of Opportunities | Read-Write Nullable |
projects | reference | List of Projects | Read-Write Nullable |
tasks | reference | List of Tasks | Read-Write Nullable |
owner | reference | URL of the User that is responsible for the note | Read-Write Non-null Default value is creator |
creator | reference | URL of the User that created the note | Read-only Non-null |
trashed | boolean | Is the item in the trash. | Read-Write Non-null |
create_date | datetime | Timestamp from when the note was created | Read-only Non-null |
modify_date | datetime | Timestamp from when the note was last updated | Read-only Non-null |
Details EncodingThe API currently does nothing to ensure the validity of
detailswhen creating a note. Until we decide on a proper encoding, the onus is on the client to submit valid data.The desktop and mobile apps are happy with RTF encoded strings, but plain text will also work. Other encodings may partially work, but will most likely not be rendered correctly.
The API currently only supports plain text when creating or editing note details.