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 History| Name | 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": "a711c375-a0cc-4e14-81a6-267eccca88d4",
"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": "2026-06-30T23:59:16Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "1410f94b-6846-4db9-b249-5c71cc0dbca2",
"EditDate": "2026-06-30T23:59:16Z",
"CreateDate": "2026-06-30T23:59:16Z",
"StartTime": "2026-06-30T23:59:16Z",
"EndTime": "2026-06-30T23:59:16Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"47b6a835-4c12-4796-9071-3b48dfce24b9",
"adeae371-e07e-480e-be09-36bf334a551c"
],
"Companies": [
"20090215-bbd6-4e1e-a61d-ce35f626e245",
"967f4e67-c81c-4805-ab70-d4b405d67bc2"
],
"Groups": [
"3834efdc-3ce3-430c-bf3e-89a30169550b",
"ef9bd084-d9be-48a2-9e32-7dcde393f684"
],
"Opportunities": [
"b5e46b7f-b1ac-4041-8395-2de1ae27ff82",
"c812aea9-1dcb-4858-bc21-edc848f4e279"
]
}
},
{
"Id": "a711c375-a0cc-4e14-81a6-267eccca88d4",
"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": "2026-06-30T23:59:16Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "1410f94b-6846-4db9-b249-5c71cc0dbca2",
"EditDate": "2026-06-30T23:59:16Z",
"CreateDate": "2026-06-30T23:59:16Z",
"StartTime": "2026-06-30T23:59:16Z",
"EndTime": "2026-06-30T23:59:16Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"47b6a835-4c12-4796-9071-3b48dfce24b9",
"adeae371-e07e-480e-be09-36bf334a551c"
],
"Companies": [
"20090215-bbd6-4e1e-a61d-ce35f626e245",
"967f4e67-c81c-4805-ab70-d4b405d67bc2"
],
"Groups": [
"3834efdc-3ce3-430c-bf3e-89a30169550b",
"ef9bd084-d9be-48a2-9e32-7dcde393f684"
],
"Opportunities": [
"b5e46b7f-b1ac-4041-8395-2de1ae27ff82",
"c812aea9-1dcb-4858-bc21-edc848f4e279"
]
}
}
]