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": "5c1c5a28-f7f0-4a10-b498-cbbb2e843b60",
    "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": "2024-12-05T02:23:04Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "8ba05536-b104-416f-af96-0bd221d3e98a",
    "EditDate": "2024-12-05T02:23:04Z",
    "CreateDate": "2024-12-05T02:23:04Z",
    "StartTime": "2024-12-05T02:23:04Z",
    "EndTime": "2024-12-05T02:23:04Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "1aea0fd1-726b-48f1-8a35-937b4cba126d",
        "8964ab57-c8d8-49a2-83ee-08a0ee72bd07"
      ],
      "Companies": [
        "668cb5ee-acfb-42b6-bbe9-cd868c1f57b2",
        "7e8b5819-b7a7-48d3-af8a-07875201b901"
      ],
      "Groups": [
        "3e5dc379-8a75-4208-ab15-022a5abb98aa",
        "84ef285a-3772-4bbc-bc5a-7fe8b55ba741"
      ],
      "Opportunities": [
        "00d7aeb5-9a69-421a-9368-f92981817916",
        "c9fbc670-7080-4c4c-9664-78bf2084ee07"
      ]
    }
  },
  {
    "Id": "5c1c5a28-f7f0-4a10-b498-cbbb2e843b60",
    "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": "2024-12-05T02:23:04Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "8ba05536-b104-416f-af96-0bd221d3e98a",
    "EditDate": "2024-12-05T02:23:04Z",
    "CreateDate": "2024-12-05T02:23:04Z",
    "StartTime": "2024-12-05T02:23:04Z",
    "EndTime": "2024-12-05T02:23:04Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "1aea0fd1-726b-48f1-8a35-937b4cba126d",
        "8964ab57-c8d8-49a2-83ee-08a0ee72bd07"
      ],
      "Companies": [
        "668cb5ee-acfb-42b6-bbe9-cd868c1f57b2",
        "7e8b5819-b7a7-48d3-af8a-07875201b901"
      ],
      "Groups": [
        "3e5dc379-8a75-4208-ab15-022a5abb98aa",
        "84ef285a-3772-4bbc-bc5a-7fe8b55ba741"
      ],
      "Opportunities": [
        "00d7aeb5-9a69-421a-9368-f92981817916",
        "c9fbc670-7080-4c4c-9664-78bf2084ee07"
      ]
    }
  }
]