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

Name	Description	Type	Additional 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": "e4a29a19-6a99-42a8-a40a-f67ccac82370",
    "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-07T18:44:18Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "97b182be-bf3e-49f3-abe9-06f11c408f77",
    "EditDate": "2024-05-07T18:44:18Z",
    "CreateDate": "2024-05-07T18:44:18Z",
    "StartTime": "2024-05-07T18:44:18Z",
    "EndTime": "2024-05-07T18:44:18Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "95e5b64d-30be-4489-94b5-cfe30d7787e6",
        "4f8dc431-5b4c-4a6e-8b2e-4a76b9a39ebf"
      ],
      "Companies": [
        "60c41cdf-32c1-40c7-9e62-216d88ded42b",
        "56cd6cd3-b1bd-46e7-a2b0-c716b5a4da02"
      ],
      "Groups": [
        "c8a119cc-30fe-48a4-93cc-31d7cef857a3",
        "b7780359-a7b5-4f49-902e-1244c4082fae"
      ],
      "Opportunities": [
        "1cc13f76-19ec-4033-872a-115c53b34293",
        "e7bb6012-37d5-4392-a95b-8888b55a92c7"
      ]
    }
  },
  {
    "Id": "e4a29a19-6a99-42a8-a40a-f67ccac82370",
    "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-07T18:44:18Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "97b182be-bf3e-49f3-abe9-06f11c408f77",
    "EditDate": "2024-05-07T18:44:18Z",
    "CreateDate": "2024-05-07T18:44:18Z",
    "StartTime": "2024-05-07T18:44:18Z",
    "EndTime": "2024-05-07T18:44:18Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "95e5b64d-30be-4489-94b5-cfe30d7787e6",
        "4f8dc431-5b4c-4a6e-8b2e-4a76b9a39ebf"
      ],
      "Companies": [
        "60c41cdf-32c1-40c7-9e62-216d88ded42b",
        "56cd6cd3-b1bd-46e7-a2b0-c716b5a4da02"
      ],
      "Groups": [
        "c8a119cc-30fe-48a4-93cc-31d7cef857a3",
        "b7780359-a7b5-4f49-902e-1244c4082fae"
      ],
      "Opportunities": [
        "1cc13f76-19ec-4033-872a-115c53b34293",
        "e7bb6012-37d5-4392-a95b-8888b55a92c7"
      ]
    }
  }
]