GET api/Notes

Get all notes in the database. Supported Headers: SelectField, Filter, Sort, Take, Skip, SortDesc, IncludeLink, DetailFormat

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Note

Name	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": "2024-05-07T10:13:37Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "EditDate": "2024-05-07T10:13:37Z",
    "CreateDate": "2024-05-07T10:13:37Z",
    "DisplayDate": "2024-05-07T10:13:37Z",
    "NoteText": "sample string 5",
    "NoteTypeID": 6,
    "ID": "386364e2-af46-4a6b-92b2-91e625a0892b",
    "ManageUserID": "b95031a6-9825-4a68-8c85-7ef2475cd81b",
    "ManageUserName": "sample string 9",
    "CreateUserID": "562683c7-be88-454f-886d-7744fc3fa61c",
    "CreateUserName": "sample string 11",
    "EditUserID": "3311d1cd-1839-4638-8c60-bee9155dd9ed",
    "EditUserName": "sample string 13",
    "IsPrivate": true,
    "LinkedEntities": {
      "Contacts": [
        "d170200b-02d7-4ade-98e3-dce885992585",
        "1785da67-4d19-4178-b963-ae40ebb123f8"
      ],
      "Companies": [
        "40dec81c-4629-44c0-8c6b-9f20a7cf8e37",
        "fb2bad61-1e20-4ac0-bb2a-00d50fbef212"
      ],
      "Groups": [
        "b609a4d0-dc6e-406d-b409-8d9104cef079",
        "d1dfc9be-c145-4b62-8417-965ab79225f8"
      ],
      "Opportunities": [
        "b5548eb9-095c-447d-9fc4-b1118787a6d7",
        "ccb3537b-d298-4b26-a10f-b183e27a6cc5"
      ]
    }
  },
  {
    "HasAttachment": true,
    "Attachment": {
      "DisplayName": "sample string 1",
      "FileSize": 2.1,
      "LastModified": "2024-05-07T10:13:37Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "EditDate": "2024-05-07T10:13:37Z",
    "CreateDate": "2024-05-07T10:13:37Z",
    "DisplayDate": "2024-05-07T10:13:37Z",
    "NoteText": "sample string 5",
    "NoteTypeID": 6,
    "ID": "386364e2-af46-4a6b-92b2-91e625a0892b",
    "ManageUserID": "b95031a6-9825-4a68-8c85-7ef2475cd81b",
    "ManageUserName": "sample string 9",
    "CreateUserID": "562683c7-be88-454f-886d-7744fc3fa61c",
    "CreateUserName": "sample string 11",
    "EditUserID": "3311d1cd-1839-4638-8c60-bee9155dd9ed",
    "EditUserName": "sample string 13",
    "IsPrivate": true,
    "LinkedEntities": {
      "Contacts": [
        "d170200b-02d7-4ade-98e3-dce885992585",
        "1785da67-4d19-4178-b963-ae40ebb123f8"
      ],
      "Companies": [
        "40dec81c-4629-44c0-8c6b-9f20a7cf8e37",
        "fb2bad61-1e20-4ac0-bb2a-00d50fbef212"
      ],
      "Groups": [
        "b609a4d0-dc6e-406d-b409-8d9104cef079",
        "d1dfc9be-c145-4b62-8417-965ab79225f8"
      ],
      "Opportunities": [
        "b5548eb9-095c-447d-9fc4-b1118787a6d7",
        "ccb3537b-d298-4b26-a10f-b183e27a6cc5"
      ]
    }
  }
]