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": "7b5f4c5e-fe06-4e81-824c-13d578ca3c72", "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-08-21T15:31:24Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "e2b89e4a-183b-4132-b023-57926ae9bbf5", "EditDate": "2025-08-21T15:31:24Z", "CreateDate": "2025-08-21T15:31:24Z", "StartTime": "2025-08-21T15:31:24Z", "EndTime": "2025-08-21T15:31:24Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "49077500-a614-47d0-a54e-c160cdc8017f", "643359b8-f488-45e5-b2b0-36534b4625c2" ], "Companies": [ "cdfb349e-3f6d-4844-9ae8-bca08d424a1b", "0487ba7d-4759-4480-8b93-ef2e617bffc9" ], "Groups": [ "711cf78e-e824-4896-921e-e4ccd835c8e8", "87be9e05-0c9d-48da-84bb-699e9752c05c" ], "Opportunities": [ "efc44dce-0ef2-4ae4-89a5-1e180a73144b", "b47578a9-b2c9-4428-90b9-76042baf58d9" ] } }, { "Id": "7b5f4c5e-fe06-4e81-824c-13d578ca3c72", "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-08-21T15:31:24Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "e2b89e4a-183b-4132-b023-57926ae9bbf5", "EditDate": "2025-08-21T15:31:24Z", "CreateDate": "2025-08-21T15:31:24Z", "StartTime": "2025-08-21T15:31:24Z", "EndTime": "2025-08-21T15:31:24Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "49077500-a614-47d0-a54e-c160cdc8017f", "643359b8-f488-45e5-b2b0-36534b4625c2" ], "Companies": [ "cdfb349e-3f6d-4844-9ae8-bca08d424a1b", "0487ba7d-4759-4480-8b93-ef2e617bffc9" ], "Groups": [ "711cf78e-e824-4896-921e-e4ccd835c8e8", "87be9e05-0c9d-48da-84bb-699e9752c05c" ], "Opportunities": [ "efc44dce-0ef2-4ae4-89a5-1e180a73144b", "b47578a9-b2c9-4428-90b9-76042baf58d9" ] } } ]