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": "de094513-df51-4456-8afc-1675f4320d4f",
    "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-05-16T02:11:29Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "34003b5c-ba19-491d-b2ca-aa8299613b1c",
    "EditDate": "2024-05-16T02:11:29Z",
    "CreateDate": "2024-05-16T02:11:29Z",
    "StartTime": "2024-05-16T02:11:29Z",
    "EndTime": "2024-05-16T02:11:29Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "9004a671-5b6b-4c7d-96ad-2b72f29f5bb1",
        "3364196e-40a3-41f6-81ab-0b5b312aab29"
      ],
      "Companies": [
        "b78599f6-258a-47b6-a6ce-43a80adbf66f",
        "1215e17e-b816-4010-be60-d27d2cf97704"
      ],
      "Groups": [
        "df287a70-a40b-4b37-aa9a-db57f4a39cda",
        "79acdbb5-ccda-488c-a536-3c0e08810bb8"
      ],
      "Opportunities": [
        "d0c73905-5902-44c9-a67b-3965aae119d8",
        "5c5d1b6d-0639-445c-8347-540576566c54"
      ]
    }
  },
  {
    "Id": "de094513-df51-4456-8afc-1675f4320d4f",
    "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-05-16T02:11:29Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "34003b5c-ba19-491d-b2ca-aa8299613b1c",
    "EditDate": "2024-05-16T02:11:29Z",
    "CreateDate": "2024-05-16T02:11:29Z",
    "StartTime": "2024-05-16T02:11:29Z",
    "EndTime": "2024-05-16T02:11:29Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "9004a671-5b6b-4c7d-96ad-2b72f29f5bb1",
        "3364196e-40a3-41f6-81ab-0b5b312aab29"
      ],
      "Companies": [
        "b78599f6-258a-47b6-a6ce-43a80adbf66f",
        "1215e17e-b816-4010-be60-d27d2cf97704"
      ],
      "Groups": [
        "df287a70-a40b-4b37-aa9a-db57f4a39cda",
        "79acdbb5-ccda-488c-a536-3c0e08810bb8"
      ],
      "Opportunities": [
        "d0c73905-5902-44c9-a67b-3965aae119d8",
        "5c5d1b6d-0639-445c-8347-540576566c54"
      ]
    }
  }
]