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": "11f60725-fa3f-471e-a01d-7ea3478826d8", "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-06-03T07:54:41Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "91431854-b4de-4611-8530-8cf912e2e2e8", "EditDate": "2025-06-03T07:54:41Z", "CreateDate": "2025-06-03T07:54:41Z", "StartTime": "2025-06-03T07:54:41Z", "EndTime": "2025-06-03T07:54:41Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "aff8cf68-7c2a-4faf-a079-3f7b2c3f115c", "f62e8736-8528-446a-ae53-e06b91ad477c" ], "Companies": [ "de3094ca-7a00-400e-8871-3aad7bdac5db", "f822d792-c52e-439c-beee-8240231a43d3" ], "Groups": [ "9b877549-340e-44ae-9464-c898db15420e", "5bea5fcb-788a-4a3c-8916-4c12987650ed" ], "Opportunities": [ "74010e67-17ce-47b4-b505-52e993586544", "e2590909-f8ac-4034-8df0-19fc1d926c95" ] } }, { "Id": "11f60725-fa3f-471e-a01d-7ea3478826d8", "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-06-03T07:54:41Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "91431854-b4de-4611-8530-8cf912e2e2e8", "EditDate": "2025-06-03T07:54:41Z", "CreateDate": "2025-06-03T07:54:41Z", "StartTime": "2025-06-03T07:54:41Z", "EndTime": "2025-06-03T07:54:41Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "aff8cf68-7c2a-4faf-a079-3f7b2c3f115c", "f62e8736-8528-446a-ae53-e06b91ad477c" ], "Companies": [ "de3094ca-7a00-400e-8871-3aad7bdac5db", "f822d792-c52e-439c-beee-8240231a43d3" ], "Groups": [ "9b877549-340e-44ae-9464-c898db15420e", "5bea5fcb-788a-4a3c-8916-4c12987650ed" ], "Opportunities": [ "74010e67-17ce-47b4-b505-52e993586544", "e2590909-f8ac-4034-8df0-19fc1d926c95" ] } } ]