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": "577b062e-1473-44d7-8aeb-86e7e25d0ca9", "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-04-19T01:52:36Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "c911117f-5821-4f68-a571-c316892abaad", "EditDate": "2025-04-19T01:52:36Z", "CreateDate": "2025-04-19T01:52:36Z", "StartTime": "2025-04-19T01:52:36Z", "EndTime": "2025-04-19T01:52:36Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "df6fc92b-928f-4c7f-9379-7c980ffd5196", "a8a6cf31-f322-4c70-a5bf-6777745cabe1" ], "Companies": [ "0ff72ee0-f589-49f2-a30f-b0142223588f", "c6046088-e024-4042-88fa-8c977aa33d9a" ], "Groups": [ "9082486d-f6a7-4a4f-92d4-3d2b2f6ebed6", "c536fb9a-9cdb-43b4-8ebf-dc27c2c4c85b" ], "Opportunities": [ "f0127580-9737-4be6-b6b7-8ede0a9df337", "fff19734-011c-47ed-8df6-f2111519b824" ] } }, { "Id": "577b062e-1473-44d7-8aeb-86e7e25d0ca9", "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-04-19T01:52:36Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "c911117f-5821-4f68-a571-c316892abaad", "EditDate": "2025-04-19T01:52:36Z", "CreateDate": "2025-04-19T01:52:36Z", "StartTime": "2025-04-19T01:52:36Z", "EndTime": "2025-04-19T01:52:36Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "df6fc92b-928f-4c7f-9379-7c980ffd5196", "a8a6cf31-f322-4c70-a5bf-6777745cabe1" ], "Companies": [ "0ff72ee0-f589-49f2-a30f-b0142223588f", "c6046088-e024-4042-88fa-8c977aa33d9a" ], "Groups": [ "9082486d-f6a7-4a4f-92d4-3d2b2f6ebed6", "c536fb9a-9cdb-43b4-8ebf-dc27c2c4c85b" ], "Opportunities": [ "f0127580-9737-4be6-b6b7-8ede0a9df337", "fff19734-011c-47ed-8df6-f2111519b824" ] } } ]