GET api/Histories/{id}
Get a History by ID. Supported Headers: SelectField, IncludeLink, DetailFormat
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
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": "229abb27-17c2-46a8-a3b9-53a0afbb6332", "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-10-18T15:52:48Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "0e2973e1-1427-42cd-9239-3ee2360e8166", "EditDate": "2025-10-18T15:52:48Z", "CreateDate": "2025-10-18T15:52:48Z", "StartTime": "2025-10-18T15:52:48Z", "EndTime": "2025-10-18T15:52:48Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "158a0944-0f02-400d-9519-1fddb34add8c", "3aab724d-af84-4fa5-8d94-581dd7aab432" ], "Companies": [ "4f659b1d-8111-4d99-b8b1-c97d96463f4d", "41808f4d-7251-4478-bf61-2391f7a82504" ], "Groups": [ "6b7a0a53-8853-492b-a765-d798d8937a6d", "2bc0d9d2-7d4e-4700-b2c3-8b57e8b72aaf" ], "Opportunities": [ "e930f89a-0430-40bb-a2d8-9e8633a7f742", "f0679ffd-b168-4efb-91ef-046dc78a432b" ] } }