GET api/Histories

Get all Histories matching an optional Filter. Supported Headers: SelectField, Filter, Sort, SortDesc, IncludeLink, DetailFormat

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of History
NameDescriptionTypeAdditional information
Id

SQL Column Name: [HISTORYID]

globally unique identifier

None.

Regarding

SQL Column Name: [REGARDING]

string

None.

Duration

SQL Column Name: [DURATION]

string

None.

OutlookID

string

None.

HistoryTypeID

SQL Column Name: [HISTORYTYPEID]

integer

None.

HistoryType

HistoryType

None.

Attachment

Attachment

None.

IsPrivate

boolean

None.

ManageUserId

globally unique identifier

None.

EditDate

SQL Column Name: [EDIT_DATE]

date

None.

CreateDate

SQL Column Name: [CREATE_DATE]

date

None.

StartTime

SQL Column Name: [START_DATE_TIME]

date

None.

EndTime

SQL Column Name: [END_DATE_TIME]

date

None.

Details

SQL Column Name: [DETAILS]

string

None.

LinkedEntities

LinkedEntities

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "60adb26f-5cf1-4425-a563-a0f3c3f196b1",
    "Regarding": "sample string 2",
    "Duration": "sample string 3",
    "OutlookID": "sample string 4",
    "HistoryTypeID": 5,
    "HistoryType": {
      "Name": "sample string 1",
      "HistoryTypeId": 2,
      "Description": "sample string 3",
      "ActivityTypeID": "sample string 4",
      "ActivityTypeName": "sample string 5",
      "IsActive": true,
      "IsCustom": true,
      "IsDefault": true,
      "IsUserRecordable": true
    },
    "Attachment": {
      "DisplayName": "sample string 1",
      "FileSize": 2.1,
      "LastModified": "2024-05-18T23:49:48Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "bb9e04aa-976e-40a8-acea-f6d39ef11312",
    "EditDate": "2024-05-18T23:49:48Z",
    "CreateDate": "2024-05-18T23:49:48Z",
    "StartTime": "2024-05-18T23:49:48Z",
    "EndTime": "2024-05-18T23:49:48Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "e4c19919-1fa9-4b63-a135-ca3d74bd2401",
        "69d81ce2-2d7f-419d-9039-bc001f3aaa63"
      ],
      "Companies": [
        "046dbe3b-9d2c-4613-aded-17c9a2c5e7ff",
        "c9931b8f-ce01-4a6f-9f52-c552dcfef5cf"
      ],
      "Groups": [
        "27377ac4-5e17-47ff-87b1-13006300bb45",
        "9fe75658-6bdc-4aa1-bf4b-7f8fe7622268"
      ],
      "Opportunities": [
        "7566387f-1ba1-4eb8-8279-46e27c21435f",
        "8c8eaa64-e4ea-45cf-adfd-171ee0e8aea3"
      ]
    }
  },
  {
    "Id": "60adb26f-5cf1-4425-a563-a0f3c3f196b1",
    "Regarding": "sample string 2",
    "Duration": "sample string 3",
    "OutlookID": "sample string 4",
    "HistoryTypeID": 5,
    "HistoryType": {
      "Name": "sample string 1",
      "HistoryTypeId": 2,
      "Description": "sample string 3",
      "ActivityTypeID": "sample string 4",
      "ActivityTypeName": "sample string 5",
      "IsActive": true,
      "IsCustom": true,
      "IsDefault": true,
      "IsUserRecordable": true
    },
    "Attachment": {
      "DisplayName": "sample string 1",
      "FileSize": 2.1,
      "LastModified": "2024-05-18T23:49:48Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "bb9e04aa-976e-40a8-acea-f6d39ef11312",
    "EditDate": "2024-05-18T23:49:48Z",
    "CreateDate": "2024-05-18T23:49:48Z",
    "StartTime": "2024-05-18T23:49:48Z",
    "EndTime": "2024-05-18T23:49:48Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "e4c19919-1fa9-4b63-a135-ca3d74bd2401",
        "69d81ce2-2d7f-419d-9039-bc001f3aaa63"
      ],
      "Companies": [
        "046dbe3b-9d2c-4613-aded-17c9a2c5e7ff",
        "c9931b8f-ce01-4a6f-9f52-c552dcfef5cf"
      ],
      "Groups": [
        "27377ac4-5e17-47ff-87b1-13006300bb45",
        "9fe75658-6bdc-4aa1-bf4b-7f8fe7622268"
      ],
      "Opportunities": [
        "7566387f-1ba1-4eb8-8279-46e27c21435f",
        "8c8eaa64-e4ea-45cf-adfd-171ee0e8aea3"
      ]
    }
  }
]