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": "50e558cd-d785-4de6-b516-8ad3d92f5d27",
"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:07:43Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "5efe38e7-976f-4b22-ba6a-482ef4a97bee",
"EditDate": "2026-10-13T14:07:43Z",
"CreateDate": "2026-10-13T14:07:43Z",
"StartTime": "2026-10-13T14:07:43Z",
"EndTime": "2026-10-13T14:07:43Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"02a5f125-c747-422f-8a88-a2b5ac458ae1",
"a670ae09-5e8d-4fb2-8c5e-d7a1a5df0c7e"
],
"Companies": [
"827a27de-ca94-4eda-9d40-547785f3f462",
"acc8da05-584f-4790-8d8e-adbb70969def"
],
"Groups": [
"9089649d-5c3b-4216-b653-e4f658aa9b55",
"68fa9a7c-0ecd-4db9-8ffb-f27db082ab4f"
],
"Opportunities": [
"469f5e8e-9505-4a8b-a95f-69fd6698f17f",
"69617900-0b42-43d1-8809-cee2dfbcef52"
]
}
},
{
"Id": "50e558cd-d785-4de6-b516-8ad3d92f5d27",
"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:07:43Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "5efe38e7-976f-4b22-ba6a-482ef4a97bee",
"EditDate": "2026-10-13T14:07:43Z",
"CreateDate": "2026-10-13T14:07:43Z",
"StartTime": "2026-10-13T14:07:43Z",
"EndTime": "2026-10-13T14:07:43Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"02a5f125-c747-422f-8a88-a2b5ac458ae1",
"a670ae09-5e8d-4fb2-8c5e-d7a1a5df0c7e"
],
"Companies": [
"827a27de-ca94-4eda-9d40-547785f3f462",
"acc8da05-584f-4790-8d8e-adbb70969def"
],
"Groups": [
"9089649d-5c3b-4216-b653-e4f658aa9b55",
"68fa9a7c-0ecd-4db9-8ffb-f27db082ab4f"
],
"Opportunities": [
"469f5e8e-9505-4a8b-a95f-69fd6698f17f",
"69617900-0b42-43d1-8809-cee2dfbcef52"
]
}
}
]