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": "15456b1d-c07d-40c3-a789-a0aad76b8008",
"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-03-02T17:26:03Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "857b7b87-3d43-42fc-b952-89514cc1f0c2",
"EditDate": "2026-03-02T17:26:03Z",
"CreateDate": "2026-03-02T17:26:03Z",
"StartTime": "2026-03-02T17:26:03Z",
"EndTime": "2026-03-02T17:26:03Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"7200df0a-fe3b-44f1-916c-66203683c654",
"71495f2d-f40e-4da9-953c-1692901e8815"
],
"Companies": [
"6b41cd89-59f2-44f8-9f06-b2aa5ec992b2",
"5aca27c9-6024-4c7c-85dd-b497513679a4"
],
"Groups": [
"6272cca4-20f4-4d74-8e1c-b98436c77826",
"de2f2f61-7b24-4530-8ac3-5f18bac2e7da"
],
"Opportunities": [
"f5cc06f1-c00a-4edd-8d84-36443f28367b",
"33ed860f-5366-416a-8aed-e1615623506d"
]
}
},
{
"Id": "15456b1d-c07d-40c3-a789-a0aad76b8008",
"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-03-02T17:26:03Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "857b7b87-3d43-42fc-b952-89514cc1f0c2",
"EditDate": "2026-03-02T17:26:03Z",
"CreateDate": "2026-03-02T17:26:03Z",
"StartTime": "2026-03-02T17:26:03Z",
"EndTime": "2026-03-02T17:26:03Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"7200df0a-fe3b-44f1-916c-66203683c654",
"71495f2d-f40e-4da9-953c-1692901e8815"
],
"Companies": [
"6b41cd89-59f2-44f8-9f06-b2aa5ec992b2",
"5aca27c9-6024-4c7c-85dd-b497513679a4"
],
"Groups": [
"6272cca4-20f4-4d74-8e1c-b98436c77826",
"de2f2f61-7b24-4530-8ac3-5f18bac2e7da"
],
"Opportunities": [
"f5cc06f1-c00a-4edd-8d84-36443f28367b",
"33ed860f-5366-416a-8aed-e1615623506d"
]
}
}
]