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": "7f842faf-c4a6-4f7e-a78b-e7c5bb9a697c", "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-18T15:52:37Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "c4776c21-5977-4a5f-adb9-278a1004e8a6", "EditDate": "2025-10-18T15:52:37Z", "CreateDate": "2025-10-18T15:52:37Z", "StartTime": "2025-10-18T15:52:37Z", "EndTime": "2025-10-18T15:52:37Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "6fe84add-c233-4093-aa91-0e07126dc31c", "4067f4e4-4d9c-444f-beec-bf5cdda9a038" ], "Companies": [ "3f53d851-8e88-45b9-a423-34d70a1b0a89", "5d4b33ca-e17b-4e36-9881-694c84c74020" ], "Groups": [ "baa526fc-3f0b-4493-87be-dd3155bcb9b0", "81a90642-7fea-405a-b945-235aa18bd689" ], "Opportunities": [ "49e6dd94-c229-4edf-be60-7de1249f735c", "f066492c-eed2-4202-8e28-8841a0a7b1ad" ] } }, { "Id": "7f842faf-c4a6-4f7e-a78b-e7c5bb9a697c", "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-18T15:52:37Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "c4776c21-5977-4a5f-adb9-278a1004e8a6", "EditDate": "2025-10-18T15:52:37Z", "CreateDate": "2025-10-18T15:52:37Z", "StartTime": "2025-10-18T15:52:37Z", "EndTime": "2025-10-18T15:52:37Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "6fe84add-c233-4093-aa91-0e07126dc31c", "4067f4e4-4d9c-444f-beec-bf5cdda9a038" ], "Companies": [ "3f53d851-8e88-45b9-a423-34d70a1b0a89", "5d4b33ca-e17b-4e36-9881-694c84c74020" ], "Groups": [ "baa526fc-3f0b-4493-87be-dd3155bcb9b0", "81a90642-7fea-405a-b945-235aa18bd689" ], "Opportunities": [ "49e6dd94-c229-4edf-be60-7de1249f735c", "f066492c-eed2-4202-8e28-8841a0a7b1ad" ] } } ]