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": "23012417-5ed8-4128-930c-3a930a544265",
"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-02-28T22:45:00Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "ab2ad5a1-3382-499d-a654-d0398d7c8daf",
"EditDate": "2026-02-28T22:45:00Z",
"CreateDate": "2026-02-28T22:45:00Z",
"StartTime": "2026-02-28T22:45:00Z",
"EndTime": "2026-02-28T22:45:00Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"cbc5dfe9-f066-4cf6-a818-eae5f6c9705b",
"1e3d6c7b-bdc2-40bd-8cd8-14ce07389267"
],
"Companies": [
"e32a2a4b-a11f-4a17-bfa5-1635c5d30330",
"338c804a-c565-4808-8d76-691e1a6ee9d5"
],
"Groups": [
"706aa3a5-51bb-44c2-8ed8-f1b4a96ea2e7",
"32a32dd4-d675-4d2b-8a83-5d87f398da01"
],
"Opportunities": [
"5055a9d4-0595-4408-b019-d68a90faf665",
"7038c5cc-ffdd-45ff-8ecd-4323c4a26758"
]
}
},
{
"Id": "23012417-5ed8-4128-930c-3a930a544265",
"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-02-28T22:45:00Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "ab2ad5a1-3382-499d-a654-d0398d7c8daf",
"EditDate": "2026-02-28T22:45:00Z",
"CreateDate": "2026-02-28T22:45:00Z",
"StartTime": "2026-02-28T22:45:00Z",
"EndTime": "2026-02-28T22:45:00Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"cbc5dfe9-f066-4cf6-a818-eae5f6c9705b",
"1e3d6c7b-bdc2-40bd-8cd8-14ce07389267"
],
"Companies": [
"e32a2a4b-a11f-4a17-bfa5-1635c5d30330",
"338c804a-c565-4808-8d76-691e1a6ee9d5"
],
"Groups": [
"706aa3a5-51bb-44c2-8ed8-f1b4a96ea2e7",
"32a32dd4-d675-4d2b-8a83-5d87f398da01"
],
"Opportunities": [
"5055a9d4-0595-4408-b019-d68a90faf665",
"7038c5cc-ffdd-45ff-8ecd-4323c4a26758"
]
}
}
]