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": "2c9c2c5b-0f46-4003-a4b1-3a9f15fea21e", "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-06-03T07:38:57Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "968678af-63a6-456c-98ed-67edb082e173", "EditDate": "2025-06-03T07:38:57Z", "CreateDate": "2025-06-03T07:38:57Z", "StartTime": "2025-06-03T07:38:57Z", "EndTime": "2025-06-03T07:38:57Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "4a655626-ca60-4bf2-ab02-0c1c28c90277", "59a405f6-47dd-4a4f-8ebe-b3c92363136c" ], "Companies": [ "3a5c07f8-55cc-477c-896c-1ae12fbb2c81", "e8b1e12c-8ef2-49fd-90d5-34e10f44d12c" ], "Groups": [ "c2b2cb66-813d-423f-97b1-af272f93dba3", "98842b60-f5aa-4a03-b5e4-598bcf9f5c68" ], "Opportunities": [ "995fc654-9060-420b-9cf8-c03abc4305ef", "b2175cee-2fc3-428b-9ea4-c06e7cb853dc" ] } }, { "Id": "2c9c2c5b-0f46-4003-a4b1-3a9f15fea21e", "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-06-03T07:38:57Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "968678af-63a6-456c-98ed-67edb082e173", "EditDate": "2025-06-03T07:38:57Z", "CreateDate": "2025-06-03T07:38:57Z", "StartTime": "2025-06-03T07:38:57Z", "EndTime": "2025-06-03T07:38:57Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "4a655626-ca60-4bf2-ab02-0c1c28c90277", "59a405f6-47dd-4a4f-8ebe-b3c92363136c" ], "Companies": [ "3a5c07f8-55cc-477c-896c-1ae12fbb2c81", "e8b1e12c-8ef2-49fd-90d5-34e10f44d12c" ], "Groups": [ "c2b2cb66-813d-423f-97b1-af272f93dba3", "98842b60-f5aa-4a03-b5e4-598bcf9f5c68" ], "Opportunities": [ "995fc654-9060-420b-9cf8-c03abc4305ef", "b2175cee-2fc3-428b-9ea4-c06e7cb853dc" ] } } ]