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": "9d589bc9-73dc-48e7-9a32-638893445dc8",
"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-08-29T12:43:20Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "57b8e28f-6e02-4fe4-894b-de1dbcc04024",
"EditDate": "2026-08-29T12:43:20Z",
"CreateDate": "2026-08-29T12:43:20Z",
"StartTime": "2026-08-29T12:43:20Z",
"EndTime": "2026-08-29T12:43:20Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"fbfe3830-64c0-4d21-a2c0-2fe8ee1e893c",
"2f9120d3-96be-4c1c-8268-de18b0845926"
],
"Companies": [
"0dda618d-eafb-4dad-bfd0-a42e3c3afea2",
"44746cc9-76c5-4270-abb9-f1b906542bd9"
],
"Groups": [
"d009e06f-f8bb-40c1-9ca7-f9672c951309",
"df6f74fc-107a-4ca5-aa6f-73bbf51ba973"
],
"Opportunities": [
"054151cc-a9da-4292-b401-cda5b61f1ef0",
"5e3e900a-a593-43cf-bdc0-c82b94883094"
]
}
},
{
"Id": "9d589bc9-73dc-48e7-9a32-638893445dc8",
"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-08-29T12:43:20Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "57b8e28f-6e02-4fe4-894b-de1dbcc04024",
"EditDate": "2026-08-29T12:43:20Z",
"CreateDate": "2026-08-29T12:43:20Z",
"StartTime": "2026-08-29T12:43:20Z",
"EndTime": "2026-08-29T12:43:20Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"fbfe3830-64c0-4d21-a2c0-2fe8ee1e893c",
"2f9120d3-96be-4c1c-8268-de18b0845926"
],
"Companies": [
"0dda618d-eafb-4dad-bfd0-a42e3c3afea2",
"44746cc9-76c5-4270-abb9-f1b906542bd9"
],
"Groups": [
"d009e06f-f8bb-40c1-9ca7-f9672c951309",
"df6f74fc-107a-4ca5-aa6f-73bbf51ba973"
],
"Opportunities": [
"054151cc-a9da-4292-b401-cda5b61f1ef0",
"5e3e900a-a593-43cf-bdc0-c82b94883094"
]
}
}
]