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": "35c0a06a-a546-43f5-9235-d9e9cee2d895",
"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-04-15T17:03:32Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "c1caaa1d-371e-4d70-83ad-02fa1c89d089",
"EditDate": "2026-04-15T17:03:32Z",
"CreateDate": "2026-04-15T17:03:32Z",
"StartTime": "2026-04-15T17:03:32Z",
"EndTime": "2026-04-15T17:03:32Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"ae41e638-b8c0-405a-a6e1-18c1e5b61d42",
"dc9f197b-a433-4a79-bcc0-504154b51422"
],
"Companies": [
"0c4c295b-e833-4761-b1d1-03cc3d0080d0",
"e27500c0-f908-4cb5-93b3-a3164b945a89"
],
"Groups": [
"df1bc8cb-6578-4161-8e57-159210d84b51",
"014eea6f-11fc-4587-ac7c-5731480ec674"
],
"Opportunities": [
"4d369876-7abc-4314-ae34-05d0ab47021b",
"c707407b-060f-462d-b9a9-2dd9049628e5"
]
}
},
{
"Id": "35c0a06a-a546-43f5-9235-d9e9cee2d895",
"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-04-15T17:03:32Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "c1caaa1d-371e-4d70-83ad-02fa1c89d089",
"EditDate": "2026-04-15T17:03:32Z",
"CreateDate": "2026-04-15T17:03:32Z",
"StartTime": "2026-04-15T17:03:32Z",
"EndTime": "2026-04-15T17:03:32Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"ae41e638-b8c0-405a-a6e1-18c1e5b61d42",
"dc9f197b-a433-4a79-bcc0-504154b51422"
],
"Companies": [
"0c4c295b-e833-4761-b1d1-03cc3d0080d0",
"e27500c0-f908-4cb5-93b3-a3164b945a89"
],
"Groups": [
"df1bc8cb-6578-4161-8e57-159210d84b51",
"014eea6f-11fc-4587-ac7c-5731480ec674"
],
"Opportunities": [
"4d369876-7abc-4314-ae34-05d0ab47021b",
"c707407b-060f-462d-b9a9-2dd9049628e5"
]
}
}
]