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 HistoryName | 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": "978dd888-3024-4733-9d53-9aa19e346674", "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": "2025-08-21T15:30:44Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "74506d2b-0fc3-4f8b-aaff-e14eba5913b3", "EditDate": "2025-08-21T15:30:44Z", "CreateDate": "2025-08-21T15:30:44Z", "StartTime": "2025-08-21T15:30:44Z", "EndTime": "2025-08-21T15:30:44Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "49c99589-c1b4-4305-bdd4-bfc092cc4ffd", "33ec79ad-7c2b-47b5-ab3b-34d75d64a0cd" ], "Companies": [ "4348e68a-eda3-4217-9d63-78da77e4ea52", "a56a0872-109e-4b37-b74f-1f45c1cdb0d8" ], "Groups": [ "54ce8a06-ab99-4f96-b63f-76f6c60b4b0a", "212746cb-1ff9-4a09-a1f3-7dfc81616cd9" ], "Opportunities": [ "cc2230bd-f235-489a-afb2-55a40fb5646a", "3d54aec2-5733-4f7f-9de6-f8282eb7cbd5" ] } }, { "Id": "978dd888-3024-4733-9d53-9aa19e346674", "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": "2025-08-21T15:30:44Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "74506d2b-0fc3-4f8b-aaff-e14eba5913b3", "EditDate": "2025-08-21T15:30:44Z", "CreateDate": "2025-08-21T15:30:44Z", "StartTime": "2025-08-21T15:30:44Z", "EndTime": "2025-08-21T15:30:44Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "49c99589-c1b4-4305-bdd4-bfc092cc4ffd", "33ec79ad-7c2b-47b5-ab3b-34d75d64a0cd" ], "Companies": [ "4348e68a-eda3-4217-9d63-78da77e4ea52", "a56a0872-109e-4b37-b74f-1f45c1cdb0d8" ], "Groups": [ "54ce8a06-ab99-4f96-b63f-76f6c60b4b0a", "212746cb-1ff9-4a09-a1f3-7dfc81616cd9" ], "Opportunities": [ "cc2230bd-f235-489a-afb2-55a40fb5646a", "3d54aec2-5733-4f7f-9de6-f8282eb7cbd5" ] } } ]