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": "51ddf151-aa6f-4e93-b5c5-61ab8c0d3370",
"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-12-31T19:18:20Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "4e639914-b825-4949-8218-b6c26c0eabed",
"EditDate": "2025-12-31T19:18:20Z",
"CreateDate": "2025-12-31T19:18:20Z",
"StartTime": "2025-12-31T19:18:20Z",
"EndTime": "2025-12-31T19:18:20Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"8d36e51b-5094-4ab5-bded-9c167526b6b5",
"6f081a4b-958e-4c00-9952-a421005216d6"
],
"Companies": [
"3ef4954b-166a-4cf6-bec7-138408e3ba36",
"412a8864-5d7f-4576-aeb8-6390e7aa408b"
],
"Groups": [
"0a9f0b79-aa95-436b-9e2f-b9b2001256f0",
"9ed9c99e-fcad-45ae-85f4-f8fd5039b150"
],
"Opportunities": [
"f4d8b016-16b8-41bb-813e-34cc529a3c4f",
"f0afbbf2-6476-4ae5-a26c-a0d03e89ae01"
]
}
},
{
"Id": "51ddf151-aa6f-4e93-b5c5-61ab8c0d3370",
"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-12-31T19:18:20Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "4e639914-b825-4949-8218-b6c26c0eabed",
"EditDate": "2025-12-31T19:18:20Z",
"CreateDate": "2025-12-31T19:18:20Z",
"StartTime": "2025-12-31T19:18:20Z",
"EndTime": "2025-12-31T19:18:20Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"8d36e51b-5094-4ab5-bded-9c167526b6b5",
"6f081a4b-958e-4c00-9952-a421005216d6"
],
"Companies": [
"3ef4954b-166a-4cf6-bec7-138408e3ba36",
"412a8864-5d7f-4576-aeb8-6390e7aa408b"
],
"Groups": [
"0a9f0b79-aa95-436b-9e2f-b9b2001256f0",
"9ed9c99e-fcad-45ae-85f4-f8fd5039b150"
],
"Opportunities": [
"f4d8b016-16b8-41bb-813e-34cc529a3c4f",
"f0afbbf2-6476-4ae5-a26c-a0d03e89ae01"
]
}
}
]