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": "d41abbd9-d454-4e53-bfc7-b05f41c8c1de", "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-10-16T14:59:00Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "babccc31-8e03-44aa-88a6-8411ab282790", "EditDate": "2025-10-16T14:59:00Z", "CreateDate": "2025-10-16T14:59:00Z", "StartTime": "2025-10-16T14:59:00Z", "EndTime": "2025-10-16T14:59:00Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "ea3f1ce2-b85f-4dfb-8ef1-5f83d07a1555", "0132f6dd-18d6-451d-bea8-5621f125c86c" ], "Companies": [ "ac6f89d1-e73b-4798-af0b-2366d21367ba", "e3437216-d045-4085-a650-d265116dd885" ], "Groups": [ "9ceaec50-9a50-45dd-b4f0-a57061ea65fb", "9c439f49-828a-464c-8822-f7f7c7a8161f" ], "Opportunities": [ "c2b159de-d392-4298-9345-69a96ff2c2fb", "41a36d65-c933-4b7a-90a0-f4789f7ff89a" ] } }, { "Id": "d41abbd9-d454-4e53-bfc7-b05f41c8c1de", "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-10-16T14:59:00Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "babccc31-8e03-44aa-88a6-8411ab282790", "EditDate": "2025-10-16T14:59:00Z", "CreateDate": "2025-10-16T14:59:00Z", "StartTime": "2025-10-16T14:59:00Z", "EndTime": "2025-10-16T14:59:00Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "ea3f1ce2-b85f-4dfb-8ef1-5f83d07a1555", "0132f6dd-18d6-451d-bea8-5621f125c86c" ], "Companies": [ "ac6f89d1-e73b-4798-af0b-2366d21367ba", "e3437216-d045-4085-a650-d265116dd885" ], "Groups": [ "9ceaec50-9a50-45dd-b4f0-a57061ea65fb", "9c439f49-828a-464c-8822-f7f7c7a8161f" ], "Opportunities": [ "c2b159de-d392-4298-9345-69a96ff2c2fb", "41a36d65-c933-4b7a-90a0-f4789f7ff89a" ] } } ]