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": "448b61a4-82cb-4faf-ab14-7edaeb9b0161",
    "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:10:17Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "82bf1112-b3ea-40ae-9017-470dc0269a39",
    "EditDate": "2025-04-19T01:10:17Z",
    "CreateDate": "2025-04-19T01:10:17Z",
    "StartTime": "2025-04-19T01:10:17Z",
    "EndTime": "2025-04-19T01:10:17Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "cab48a6e-84da-46a2-ab53-7a5ab3592641",
        "dc66fc55-abbe-490c-b7b8-a9554ceb44df"
      ],
      "Companies": [
        "9c811c2d-f4ff-47db-bf12-8ff174f4ad82",
        "2107e1e6-9a34-4a22-afdc-a196779b0f81"
      ],
      "Groups": [
        "e8ad6ef2-5b6a-4b81-bfb0-a52b5de2ef2d",
        "7bec5f0d-4313-4387-92ef-4cc24b2afa37"
      ],
      "Opportunities": [
        "37afc73d-d0ba-4a1f-a5d4-cf57fe7877dc",
        "a5991d89-2450-498e-b174-5c05771c9c15"
      ]
    }
  },
  {
    "Id": "448b61a4-82cb-4faf-ab14-7edaeb9b0161",
    "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:10:17Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "82bf1112-b3ea-40ae-9017-470dc0269a39",
    "EditDate": "2025-04-19T01:10:17Z",
    "CreateDate": "2025-04-19T01:10:17Z",
    "StartTime": "2025-04-19T01:10:17Z",
    "EndTime": "2025-04-19T01:10:17Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "cab48a6e-84da-46a2-ab53-7a5ab3592641",
        "dc66fc55-abbe-490c-b7b8-a9554ceb44df"
      ],
      "Companies": [
        "9c811c2d-f4ff-47db-bf12-8ff174f4ad82",
        "2107e1e6-9a34-4a22-afdc-a196779b0f81"
      ],
      "Groups": [
        "e8ad6ef2-5b6a-4b81-bfb0-a52b5de2ef2d",
        "7bec5f0d-4313-4387-92ef-4cc24b2afa37"
      ],
      "Opportunities": [
        "37afc73d-d0ba-4a1f-a5d4-cf57fe7877dc",
        "a5991d89-2450-498e-b174-5c05771c9c15"
      ]
    }
  }
]