GET api/Histories/{id}?mainEntityType={mainEntityType}
Get all Histories linked to a main entity record. Supported Headers: SelectField, IncludeLink, DetailFormat
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Id of the main entity record |
globally unique identifier |
Required |
mainEntityType | MainEntityType |
Required |
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": "858c05ac-bfca-4c77-a20d-d885149aa8ab", "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-07-19T05:52:48Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "13257b3a-3062-416d-ac93-bcc2013648f9", "EditDate": "2025-07-19T05:52:48Z", "CreateDate": "2025-07-19T05:52:48Z", "StartTime": "2025-07-19T05:52:48Z", "EndTime": "2025-07-19T05:52:48Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "8411fa9d-fa52-427e-bed7-73e4f08c5fa4", "5a3397c4-8007-4ddc-85b0-9951d3c5b1b9" ], "Companies": [ "5c4fbbd1-fad0-458f-8088-c6ecf51532e6", "24ab1342-27ab-4c12-90c2-10d4c7056590" ], "Groups": [ "5726eda9-575f-40c7-8b04-f555ed5cac2c", "4c29213f-8761-43d2-b975-fb8750b2a1cf" ], "Opportunities": [ "91281ccf-ea43-4033-8c6f-2b5a382286eb", "05477bde-d2c2-456a-b347-86ab0acdb1a8" ] } }, { "Id": "858c05ac-bfca-4c77-a20d-d885149aa8ab", "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-07-19T05:52:48Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "13257b3a-3062-416d-ac93-bcc2013648f9", "EditDate": "2025-07-19T05:52:48Z", "CreateDate": "2025-07-19T05:52:48Z", "StartTime": "2025-07-19T05:52:48Z", "EndTime": "2025-07-19T05:52:48Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "8411fa9d-fa52-427e-bed7-73e4f08c5fa4", "5a3397c4-8007-4ddc-85b0-9951d3c5b1b9" ], "Companies": [ "5c4fbbd1-fad0-458f-8088-c6ecf51532e6", "24ab1342-27ab-4c12-90c2-10d4c7056590" ], "Groups": [ "5726eda9-575f-40c7-8b04-f555ed5cac2c", "4c29213f-8761-43d2-b975-fb8750b2a1cf" ], "Opportunities": [ "91281ccf-ea43-4033-8c6f-2b5a382286eb", "05477bde-d2c2-456a-b347-86ab0acdb1a8" ] } } ]