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 HistoryName | 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": "87498ab2-0563-446b-93e6-7cc4d7065903", "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": "2025-07-05T09:55:55Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "bfe4c901-21fb-4dad-8419-60e40edf112e", "EditDate": "2025-07-05T09:55:55Z", "CreateDate": "2025-07-05T09:55:55Z", "StartTime": "2025-07-05T09:55:55Z", "EndTime": "2025-07-05T09:55:55Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "c44baaa0-9816-49c0-908a-eb0146b65989", "289f4fd9-501a-4d11-a9ee-26769916cb70" ], "Companies": [ "e81adeee-2a5d-4133-a68f-056c2c7f61d6", "f6c56e20-21dd-44bf-8582-a3535d925412" ], "Groups": [ "a419ae59-3e5e-4355-ab08-dc54056f694b", "719df6e7-4dc6-427b-b1c9-62555f286cca" ], "Opportunities": [ "3b67f95a-3d06-4df7-b2b7-2771c22a5e0c", "b2ca9e1a-e42f-4d88-b565-10b1c837a0b9" ] } }, { "Id": "87498ab2-0563-446b-93e6-7cc4d7065903", "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": "2025-07-05T09:55:55Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "bfe4c901-21fb-4dad-8419-60e40edf112e", "EditDate": "2025-07-05T09:55:55Z", "CreateDate": "2025-07-05T09:55:55Z", "StartTime": "2025-07-05T09:55:55Z", "EndTime": "2025-07-05T09:55:55Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "c44baaa0-9816-49c0-908a-eb0146b65989", "289f4fd9-501a-4d11-a9ee-26769916cb70" ], "Companies": [ "e81adeee-2a5d-4133-a68f-056c2c7f61d6", "f6c56e20-21dd-44bf-8582-a3535d925412" ], "Groups": [ "a419ae59-3e5e-4355-ab08-dc54056f694b", "719df6e7-4dc6-427b-b1c9-62555f286cca" ], "Opportunities": [ "3b67f95a-3d06-4df7-b2b7-2771c22a5e0c", "b2ca9e1a-e42f-4d88-b565-10b1c837a0b9" ] } } ]