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": "13a0e1ec-410b-4438-9e24-824fffe81376", "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-04-19T01:21:00Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "1d700224-b5df-4d50-b8d0-cf604e07129e", "EditDate": "2025-04-19T01:21:00Z", "CreateDate": "2025-04-19T01:21:00Z", "StartTime": "2025-04-19T01:21:00Z", "EndTime": "2025-04-19T01:21:00Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "11cd0f41-5fca-4b49-9c67-78bd1a93aed1", "9cfccf4e-d58b-4d8d-bbcd-acdec04c8cb7" ], "Companies": [ "4eecebd7-b53e-45e1-bd35-cca3de1e0354", "2c2c7c63-5e92-4a8a-9793-24daf9f3aeaf" ], "Groups": [ "85519883-16be-41ff-8127-14d9007a15f7", "08e8c63b-18a3-41b9-8119-552ec17882b4" ], "Opportunities": [ "fc7bd02b-e7e9-400f-8db6-6493c50b0f58", "948bb43b-e3bd-4c83-aa54-f37f891394bf" ] } }