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": "d676f2a2-ad5e-4823-af07-0719b19f0dd9", "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-09-02T20:32:53Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "23c6d973-ce26-47fe-af8c-535edfc5ff85", "EditDate": "2025-09-02T20:32:53Z", "CreateDate": "2025-09-02T20:32:53Z", "StartTime": "2025-09-02T20:32:53Z", "EndTime": "2025-09-02T20:32:53Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "6aa70392-1df6-42cb-977e-eb7bd5a8ecf6", "f50b082a-c318-464c-bcc4-f4bc9d634713" ], "Companies": [ "65d76e4f-b96d-424f-9796-b26f4f9251ad", "f41723c0-d8ec-4c0d-807b-621d0ceb69c4" ], "Groups": [ "85d409cf-894b-49b7-8ba3-766991aca631", "a04f41ff-8920-4ec4-bb5b-0f9ff3945b35" ], "Opportunities": [ "7f44bed9-6bdb-460a-b97d-81afbc201a85", "57fbc96c-0bca-47e9-a186-ee9f353167df" ] } }, { "Id": "d676f2a2-ad5e-4823-af07-0719b19f0dd9", "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-09-02T20:32:53Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "23c6d973-ce26-47fe-af8c-535edfc5ff85", "EditDate": "2025-09-02T20:32:53Z", "CreateDate": "2025-09-02T20:32:53Z", "StartTime": "2025-09-02T20:32:53Z", "EndTime": "2025-09-02T20:32:53Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "6aa70392-1df6-42cb-977e-eb7bd5a8ecf6", "f50b082a-c318-464c-bcc4-f4bc9d634713" ], "Companies": [ "65d76e4f-b96d-424f-9796-b26f4f9251ad", "f41723c0-d8ec-4c0d-807b-621d0ceb69c4" ], "Groups": [ "85d409cf-894b-49b7-8ba3-766991aca631", "a04f41ff-8920-4ec4-bb5b-0f9ff3945b35" ], "Opportunities": [ "7f44bed9-6bdb-460a-b97d-81afbc201a85", "57fbc96c-0bca-47e9-a186-ee9f353167df" ] } } ]