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": "0fa9cb81-a34f-49dd-a661-36fd605f56e8", "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:51:23Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "bf1a42bb-0b8e-4cba-9a88-78adb4b1b7c2", "EditDate": "2025-10-16T14:51:23Z", "CreateDate": "2025-10-16T14:51:23Z", "StartTime": "2025-10-16T14:51:23Z", "EndTime": "2025-10-16T14:51:23Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "d5e0d97e-fba9-43fc-98a2-b0579a9aa0a9", "c22d4706-2872-434c-81a5-6402d3401cc9" ], "Companies": [ "2343a117-90fa-4c79-8fc6-06a7c99958c0", "1923d5ca-f2b6-42be-a7b4-8b792c540a15" ], "Groups": [ "27100351-b834-4e0a-8106-ec17028aa9e9", "b54bf859-9e8f-4496-b57c-7f9b98c39769" ], "Opportunities": [ "380c0901-4095-45be-a07a-8fc01ae35af3", "1fdb5a9a-bc65-45a7-8ba8-c1bee6d248d9" ] } }, { "Id": "0fa9cb81-a34f-49dd-a661-36fd605f56e8", "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:51:23Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "bf1a42bb-0b8e-4cba-9a88-78adb4b1b7c2", "EditDate": "2025-10-16T14:51:23Z", "CreateDate": "2025-10-16T14:51:23Z", "StartTime": "2025-10-16T14:51:23Z", "EndTime": "2025-10-16T14:51:23Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "d5e0d97e-fba9-43fc-98a2-b0579a9aa0a9", "c22d4706-2872-434c-81a5-6402d3401cc9" ], "Companies": [ "2343a117-90fa-4c79-8fc6-06a7c99958c0", "1923d5ca-f2b6-42be-a7b4-8b792c540a15" ], "Groups": [ "27100351-b834-4e0a-8106-ec17028aa9e9", "b54bf859-9e8f-4496-b57c-7f9b98c39769" ], "Opportunities": [ "380c0901-4095-45be-a07a-8fc01ae35af3", "1fdb5a9a-bc65-45a7-8ba8-c1bee6d248d9" ] } } ]