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": "bbd37acd-fe89-4c7d-a406-36898b8b45f4",
    "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-04T13:18:09Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "7e89e061-cad1-4936-b085-d41274cf350c",
    "EditDate": "2024-05-04T13:18:09Z",
    "CreateDate": "2024-05-04T13:18:09Z",
    "StartTime": "2024-05-04T13:18:09Z",
    "EndTime": "2024-05-04T13:18:09Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "e2dade4e-cf19-41e5-88bb-8c1975dadd41",
        "59988a13-e8e4-47b2-a33f-8b9e1e75fb56"
      ],
      "Companies": [
        "d5e6219a-5166-4f44-8a19-88becb0357c4",
        "dde08f2b-85ed-458e-a897-77cdf25214ea"
      ],
      "Groups": [
        "463e349a-98e2-426c-a077-9fa8f31fd1d8",
        "ca2e7ae6-5845-4499-b77d-9d71a54aa212"
      ],
      "Opportunities": [
        "4f1b7283-18ef-4a9a-aa2e-307914e44f42",
        "98476865-a118-4822-9f51-810e02025bc1"
      ]
    }
  },
  {
    "Id": "bbd37acd-fe89-4c7d-a406-36898b8b45f4",
    "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-04T13:18:09Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "7e89e061-cad1-4936-b085-d41274cf350c",
    "EditDate": "2024-05-04T13:18:09Z",
    "CreateDate": "2024-05-04T13:18:09Z",
    "StartTime": "2024-05-04T13:18:09Z",
    "EndTime": "2024-05-04T13:18:09Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "e2dade4e-cf19-41e5-88bb-8c1975dadd41",
        "59988a13-e8e4-47b2-a33f-8b9e1e75fb56"
      ],
      "Companies": [
        "d5e6219a-5166-4f44-8a19-88becb0357c4",
        "dde08f2b-85ed-458e-a897-77cdf25214ea"
      ],
      "Groups": [
        "463e349a-98e2-426c-a077-9fa8f31fd1d8",
        "ca2e7ae6-5845-4499-b77d-9d71a54aa212"
      ],
      "Opportunities": [
        "4f1b7283-18ef-4a9a-aa2e-307914e44f42",
        "98476865-a118-4822-9f51-810e02025bc1"
      ]
    }
  }
]