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-06-03T07:43:14Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2025-06-03T07:43:14Z", "CreateDate": "2025-06-03T07:43:14Z", "DisplayDate": "2025-06-03T07:43:14Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "58561a02-4c57-4505-a71a-17e9584a6854", "ManageUserID": "49cd8a59-da4d-4196-bc0f-e3dbf2147171", "ManageUserName": "sample string 9", "CreateUserID": "d3d24812-2dcc-4b50-8aab-68b53def7742", "CreateUserName": "sample string 11", "EditUserID": "5f053854-dd1e-4e17-9252-6f5d4d182013", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "790159b4-a367-4dd9-befd-8cf50f79b9cf", "406b44b5-b8ca-4656-bb23-3fd64ba34828" ], "Companies": [ "2548ba68-9265-4d45-b15c-85713aaaf360", "9e8673dd-8c66-4f44-abf5-25b1aa745946" ], "Groups": [ "ffe7bb8b-0bef-4201-a67d-5e1689790f0a", "0d784940-210e-47ed-8cce-1e51af6110e7" ], "Opportunities": [ "0b2d9e99-634b-46b6-870d-69618eb75863", "9742bc73-19a0-4af7-a788-3a677c8fa3a9" ] } }