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": "9a327d1e-0db8-4a71-b6e6-ce6a098842d9",
"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-10-13T14:08:08Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "cd148de0-f5aa-43d0-8eff-4b144bcac98c",
"EditDate": "2026-10-13T14:08:08Z",
"CreateDate": "2026-10-13T14:08:08Z",
"StartTime": "2026-10-13T14:08:08Z",
"EndTime": "2026-10-13T14:08:08Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"054b0d01-a6af-4a80-a959-3a3447110457",
"376ecad5-2cf9-4de7-b599-7f5617a51b7d"
],
"Companies": [
"82162341-de80-43e8-901f-5794d4fc3899",
"a38168a1-620a-420b-81e1-ead82d1bab19"
],
"Groups": [
"5d11aef2-6c44-4224-b87e-2030380fc141",
"0074137e-414a-4734-9ec9-c9ea5de3dc21"
],
"Opportunities": [
"549352b3-d3ae-4f3a-8fb0-8212c296b580",
"32a0ebe1-ce01-4d73-b4a0-2e325ae519f2"
]
}
},
{
"Id": "9a327d1e-0db8-4a71-b6e6-ce6a098842d9",
"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-10-13T14:08:08Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "cd148de0-f5aa-43d0-8eff-4b144bcac98c",
"EditDate": "2026-10-13T14:08:08Z",
"CreateDate": "2026-10-13T14:08:08Z",
"StartTime": "2026-10-13T14:08:08Z",
"EndTime": "2026-10-13T14:08:08Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"054b0d01-a6af-4a80-a959-3a3447110457",
"376ecad5-2cf9-4de7-b599-7f5617a51b7d"
],
"Companies": [
"82162341-de80-43e8-901f-5794d4fc3899",
"a38168a1-620a-420b-81e1-ead82d1bab19"
],
"Groups": [
"5d11aef2-6c44-4224-b87e-2030380fc141",
"0074137e-414a-4734-9ec9-c9ea5de3dc21"
],
"Opportunities": [
"549352b3-d3ae-4f3a-8fb0-8212c296b580",
"32a0ebe1-ce01-4d73-b4a0-2e325ae519f2"
]
}
}
]