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": "b3a88dc3-5525-49ad-bbdd-08fecedda26a", "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-05T08:47:32Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "921d6a6d-ecab-4b6c-b276-5d98627852eb", "EditDate": "2025-07-05T08:47:32Z", "CreateDate": "2025-07-05T08:47:32Z", "StartTime": "2025-07-05T08:47:32Z", "EndTime": "2025-07-05T08:47:32Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "c8f7be0e-0e6b-4a51-8e9c-03db5da48ffe", "02fbdbb4-72c9-4f4c-a9ad-e981b0e451eb" ], "Companies": [ "8c8ca0ad-5c24-4505-bb61-14c448c8989f", "3dbc05b6-0f9b-4cad-aeb8-b2e9d39d4855" ], "Groups": [ "adc76662-6dd4-4650-8fdd-d2cafcaf0da2", "6ff689ea-850a-4916-826b-2161c87a811e" ], "Opportunities": [ "770f14ff-4ede-4ad2-bd21-9b11aec1ece1", "003d131a-d1c8-4cf9-bfd1-2aee2742204d" ] } }, { "Id": "b3a88dc3-5525-49ad-bbdd-08fecedda26a", "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-05T08:47:32Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "921d6a6d-ecab-4b6c-b276-5d98627852eb", "EditDate": "2025-07-05T08:47:32Z", "CreateDate": "2025-07-05T08:47:32Z", "StartTime": "2025-07-05T08:47:32Z", "EndTime": "2025-07-05T08:47:32Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "c8f7be0e-0e6b-4a51-8e9c-03db5da48ffe", "02fbdbb4-72c9-4f4c-a9ad-e981b0e451eb" ], "Companies": [ "8c8ca0ad-5c24-4505-bb61-14c448c8989f", "3dbc05b6-0f9b-4cad-aeb8-b2e9d39d4855" ], "Groups": [ "adc76662-6dd4-4650-8fdd-d2cafcaf0da2", "6ff689ea-850a-4916-826b-2161c87a811e" ], "Opportunities": [ "770f14ff-4ede-4ad2-bd21-9b11aec1ece1", "003d131a-d1c8-4cf9-bfd1-2aee2742204d" ] } } ]