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": "8f0a0903-c09f-4419-874f-46840eebbb7d",
"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-28T23:48:05Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "5d03a631-93e9-4c6f-b124-b56584881ed6",
"EditDate": "2026-02-28T23:48:05Z",
"CreateDate": "2026-02-28T23:48:05Z",
"StartTime": "2026-02-28T23:48:05Z",
"EndTime": "2026-02-28T23:48:05Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"ab8065b5-2f95-4f4c-86a5-d8576b6627a8",
"fab95f7f-c679-4aa8-9313-d1cfc9d78a63"
],
"Companies": [
"6d96a6c7-f365-4cec-8791-26a9d4a846a6",
"f7bc35db-9337-4e1c-b0eb-f6b942de2a64"
],
"Groups": [
"be614048-c98d-4f70-b702-23d67d761376",
"6ed51193-02ab-4338-9638-3066f5b6f19b"
],
"Opportunities": [
"acb1a5f9-6218-443f-a19d-b9bf5c2861bf",
"ae61e725-cc68-428a-871f-dbbf1e32847c"
]
}
},
{
"Id": "8f0a0903-c09f-4419-874f-46840eebbb7d",
"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-28T23:48:05Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "5d03a631-93e9-4c6f-b124-b56584881ed6",
"EditDate": "2026-02-28T23:48:05Z",
"CreateDate": "2026-02-28T23:48:05Z",
"StartTime": "2026-02-28T23:48:05Z",
"EndTime": "2026-02-28T23:48:05Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"ab8065b5-2f95-4f4c-86a5-d8576b6627a8",
"fab95f7f-c679-4aa8-9313-d1cfc9d78a63"
],
"Companies": [
"6d96a6c7-f365-4cec-8791-26a9d4a846a6",
"f7bc35db-9337-4e1c-b0eb-f6b942de2a64"
],
"Groups": [
"be614048-c98d-4f70-b702-23d67d761376",
"6ed51193-02ab-4338-9638-3066f5b6f19b"
],
"Opportunities": [
"acb1a5f9-6218-443f-a19d-b9bf5c2861bf",
"ae61e725-cc68-428a-871f-dbbf1e32847c"
]
}
}
]