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-11T06:55:57Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2025-04-11T06:55:57Z", "CreateDate": "2025-04-11T06:55:57Z", "DisplayDate": "2025-04-11T06:55:57Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "6dcc10c8-8c45-42c4-bc31-4ceb91b9eed5", "ManageUserID": "ed6db6bc-9605-43bf-8afa-d7c34719bd88", "ManageUserName": "sample string 9", "CreateUserID": "e71c8bda-e646-4107-ae72-b0062ae3690e", "CreateUserName": "sample string 11", "EditUserID": "ad4dba63-ce45-47f6-a399-990d8ad19264", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "df2e9a27-05d7-41ef-ac28-1d90e40bec78", "dd97579b-57b0-4c89-a984-9fa9dccb1510" ], "Companies": [ "eb657196-10bd-4298-bacc-2e5db657b121", "fc4369a4-d151-4332-b6ff-ba34f34254d1" ], "Groups": [ "3f19cd3a-9786-4d5b-bc4f-be8924521a31", "ca0c5f4f-c529-45d7-a11a-2fc6fcf06b8e" ], "Opportunities": [ "e4dc2b3e-acff-4c36-b405-da0c1e878dcb", "d1b14d18-30f7-4e5a-acff-6d2cbe760998" ] } }