GET api/Histories
Get all Histories matching an optional Filter. Supported Headers: SelectField, Filter, Sort, SortDesc, IncludeLink, DetailFormat
Request Information
URI Parameters
None.
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": "160365a7-9716-4759-83df-7d1f75d605e6",
"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-01-01T22:51:20Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "4fd46c96-eba6-4aa5-9f6e-f771f44d9275",
"EditDate": "2026-01-01T22:51:20Z",
"CreateDate": "2026-01-01T22:51:20Z",
"StartTime": "2026-01-01T22:51:20Z",
"EndTime": "2026-01-01T22:51:20Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"ad679a54-9c43-4915-98af-1c0111d9add5",
"f7818ec7-afa2-45ae-bdbd-35215b68d6d4"
],
"Companies": [
"0c86c681-18ab-4ba5-90f6-32d8af50341c",
"e73bb559-e42d-417f-805d-16b4cb48b9af"
],
"Groups": [
"7b8bea8d-8218-4b28-ba7e-cd0700959803",
"ddf11a62-3897-4a3a-9a6a-719ad10a697b"
],
"Opportunities": [
"24592d39-72c4-430c-abd2-25f7dfe4e574",
"deb80e90-c4e5-4cac-b602-6b7da1309c2b"
]
}
},
{
"Id": "160365a7-9716-4759-83df-7d1f75d605e6",
"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-01-01T22:51:20Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "4fd46c96-eba6-4aa5-9f6e-f771f44d9275",
"EditDate": "2026-01-01T22:51:20Z",
"CreateDate": "2026-01-01T22:51:20Z",
"StartTime": "2026-01-01T22:51:20Z",
"EndTime": "2026-01-01T22:51:20Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"ad679a54-9c43-4915-98af-1c0111d9add5",
"f7818ec7-afa2-45ae-bdbd-35215b68d6d4"
],
"Companies": [
"0c86c681-18ab-4ba5-90f6-32d8af50341c",
"e73bb559-e42d-417f-805d-16b4cb48b9af"
],
"Groups": [
"7b8bea8d-8218-4b28-ba7e-cd0700959803",
"ddf11a62-3897-4a3a-9a6a-719ad10a697b"
],
"Opportunities": [
"24592d39-72c4-430c-abd2-25f7dfe4e574",
"deb80e90-c4e5-4cac-b602-6b7da1309c2b"
]
}
}
]