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
NameDescriptionTypeAdditional 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-04T07:36:11Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "EditDate": "2024-05-04T07:36:11Z",
    "CreateDate": "2024-05-04T07:36:11Z",
    "DisplayDate": "2024-05-04T07:36:11Z",
    "NoteText": "sample string 5",
    "NoteTypeID": 6,
    "ID": "7f7f1985-ac83-4b19-8dea-e692ee1547fa",
    "ManageUserID": "40e469ff-e755-474d-b91c-7103ec47f09e",
    "ManageUserName": "sample string 9",
    "CreateUserID": "b0019e72-9335-4e92-bf4d-1d8e57103f99",
    "CreateUserName": "sample string 11",
    "EditUserID": "943aa1f0-391f-4323-aef2-067abe7300ac",
    "EditUserName": "sample string 13",
    "IsPrivate": true,
    "LinkedEntities": {
      "Contacts": [
        "db2e2f7b-4536-40a6-881a-d8a94d93a3ba",
        "dd28dbff-7316-4cef-aa51-b832c096aae9"
      ],
      "Companies": [
        "a000f8b4-8e5f-4b49-bffe-a53044c47988",
        "81666505-053a-4de7-866d-c48e532321ae"
      ],
      "Groups": [
        "0b02138d-4ae5-480d-8094-652e8f3d6a60",
        "8f7b4dd4-015a-4942-9a53-a1700ee40cba"
      ],
      "Opportunities": [
        "d8207782-d3c2-4c78-ad0f-a8e83776e24e",
        "e4fc6b5d-4289-48b3-94ce-3f7200c055de"
      ]
    }
  },
  {
    "HasAttachment": true,
    "Attachment": {
      "DisplayName": "sample string 1",
      "FileSize": 2.1,
      "LastModified": "2024-05-04T07:36:11Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "EditDate": "2024-05-04T07:36:11Z",
    "CreateDate": "2024-05-04T07:36:11Z",
    "DisplayDate": "2024-05-04T07:36:11Z",
    "NoteText": "sample string 5",
    "NoteTypeID": 6,
    "ID": "7f7f1985-ac83-4b19-8dea-e692ee1547fa",
    "ManageUserID": "40e469ff-e755-474d-b91c-7103ec47f09e",
    "ManageUserName": "sample string 9",
    "CreateUserID": "b0019e72-9335-4e92-bf4d-1d8e57103f99",
    "CreateUserName": "sample string 11",
    "EditUserID": "943aa1f0-391f-4323-aef2-067abe7300ac",
    "EditUserName": "sample string 13",
    "IsPrivate": true,
    "LinkedEntities": {
      "Contacts": [
        "db2e2f7b-4536-40a6-881a-d8a94d93a3ba",
        "dd28dbff-7316-4cef-aa51-b832c096aae9"
      ],
      "Companies": [
        "a000f8b4-8e5f-4b49-bffe-a53044c47988",
        "81666505-053a-4de7-866d-c48e532321ae"
      ],
      "Groups": [
        "0b02138d-4ae5-480d-8094-652e8f3d6a60",
        "8f7b4dd4-015a-4942-9a53-a1700ee40cba"
      ],
      "Opportunities": [
        "d8207782-d3c2-4c78-ad0f-a8e83776e24e",
        "e4fc6b5d-4289-48b3-94ce-3f7200c055de"
      ]
    }
  }
]