GET api/Notes/{id}
Get Note by Id. Supported Headers: SelectField, IncludeLink, DetailFormat
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
NoteName | Description | Type | Additional information |
---|---|---|---|
HasAttachment | boolean |
None. |
|
Attachment | Attachment |
None. |
|
EditDate |
SQL Column Name: [EDIT_DATE] |
date |
None. |
CreateDate |
SQL Column Name: [CREATE_DATE] |
date |
None. |
DisplayDate |
SQL Column Name: [NOTE_DATE] |
date |
None. |
NoteText |
SQL Column Name: [NOTE] |
string |
None. |
NoteTypeID |
SQL Column Name: [NOTETYPEID] |
integer |
None. |
ID |
SQL Column Name: [NOTEID] |
globally unique identifier |
None. |
ManageUserID | globally unique identifier |
None. |
|
ManageUserName |
SQL Column Name: [RECORD_MANAGER] |
string |
None. |
CreateUserID | globally unique identifier |
None. |
|
CreateUserName |
SQL Column Name: [RECORD_CREATOR] |
string |
None. |
EditUserID | globally unique identifier |
None. |
|
EditUserName |
SQL Column Name: [LAST_EDITED_BY] |
string |
None. |
IsPrivate |
SQL Column Name: [PRIVATE] |
boolean |
None. |
LinkedEntities | LinkedEntities |
None. |
Response Formats
application/json, text/json
Sample:
{ "HasAttachment": true, "Attachment": { "DisplayName": "sample string 1", "FileSize": 2.1, "LastModified": "2025-04-17T22:19:14Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2025-04-17T22:19:14Z", "CreateDate": "2025-04-17T22:19:14Z", "DisplayDate": "2025-04-17T22:19:14Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "0f2d8c80-c81e-4896-811a-6385b0d149fe", "ManageUserID": "2d2496ed-17db-412e-aff0-2da0d379d2fd", "ManageUserName": "sample string 9", "CreateUserID": "e10ad42c-2d16-4e63-a109-8b3792be67e9", "CreateUserName": "sample string 11", "EditUserID": "efb5e63a-0fa0-4512-b305-d95b32c244f5", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "62bd2c67-4481-49c1-b87f-5c1d640ff9f6", "11105176-9821-400e-86a2-d0a250112d0d" ], "Companies": [ "46fb29d1-3289-4791-87a9-e227c802be09", "6c516ae8-f1cc-4cb2-bbbc-8da345756bfc" ], "Groups": [ "097a84cf-9049-4bdb-8c88-79a4f1ea6900", "d511afe8-1207-4695-81be-52d4aa282622" ], "Opportunities": [ "081120d8-7f52-484f-b59a-dfba40e441c4", "1aa17946-ff59-4656-9d81-83fe0e46aa13" ] } }