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": "5663d102-962e-4e46-a3c2-c414d59426d5",
"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-06-30T23:57:47Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "5fe5a6a4-31d3-409e-a938-bc95a7eeb422",
"EditDate": "2026-06-30T23:57:47Z",
"CreateDate": "2026-06-30T23:57:47Z",
"StartTime": "2026-06-30T23:57:47Z",
"EndTime": "2026-06-30T23:57:47Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"8ca64477-99bc-4899-b1d1-22070b72a91e",
"f01aeb8e-0a01-4a07-9cb8-b6808026467e"
],
"Companies": [
"e9abfa60-aa85-43df-99a5-3a582975bf3a",
"83e8712d-73b7-4027-a959-9a5ec7b19e94"
],
"Groups": [
"4cf46cd9-40e8-42d6-a288-5e779ae3ec9d",
"8dd1e90a-1296-45bb-9152-bc5790ae338f"
],
"Opportunities": [
"7485a8e0-5d1d-43bc-bba7-a020c774cbea",
"c8786e1f-3f48-4905-9d79-17bb564b15f5"
]
}
},
{
"Id": "5663d102-962e-4e46-a3c2-c414d59426d5",
"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-06-30T23:57:47Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "5fe5a6a4-31d3-409e-a938-bc95a7eeb422",
"EditDate": "2026-06-30T23:57:47Z",
"CreateDate": "2026-06-30T23:57:47Z",
"StartTime": "2026-06-30T23:57:47Z",
"EndTime": "2026-06-30T23:57:47Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"8ca64477-99bc-4899-b1d1-22070b72a91e",
"f01aeb8e-0a01-4a07-9cb8-b6808026467e"
],
"Companies": [
"e9abfa60-aa85-43df-99a5-3a582975bf3a",
"83e8712d-73b7-4027-a959-9a5ec7b19e94"
],
"Groups": [
"4cf46cd9-40e8-42d6-a288-5e779ae3ec9d",
"8dd1e90a-1296-45bb-9152-bc5790ae338f"
],
"Opportunities": [
"7485a8e0-5d1d-43bc-bba7-a020c774cbea",
"c8786e1f-3f48-4905-9d79-17bb564b15f5"
]
}
}
]