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
NameDescriptionTypeAdditional 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": "ee4d2907-e3ce-4fd4-b79f-9d76d79d7e10",
    "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-11T06:56:30Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "90b7f595-9701-4c50-8814-e32f96cef2fc",
    "EditDate": "2025-04-11T06:56:30Z",
    "CreateDate": "2025-04-11T06:56:30Z",
    "StartTime": "2025-04-11T06:56:30Z",
    "EndTime": "2025-04-11T06:56:30Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "c703c627-5f50-45e5-958d-b388bf0dffb8",
        "47128b40-6833-4b60-a065-9aaa46f28d07"
      ],
      "Companies": [
        "7302e1c8-97e2-478a-88bf-149bfd69b7e8",
        "e02d290c-5ef8-4bef-8072-adf9abe25652"
      ],
      "Groups": [
        "1cbde62c-eaa3-4e71-9ebd-b09e554ebaf3",
        "3cdbb842-6a64-4634-9987-820030b710bf"
      ],
      "Opportunities": [
        "9d45cc32-b008-43a3-b915-0c91db3bdb86",
        "24536d2a-cc77-432c-a1f9-91ccd6739fea"
      ]
    }
  },
  {
    "Id": "ee4d2907-e3ce-4fd4-b79f-9d76d79d7e10",
    "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-11T06:56:30Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "90b7f595-9701-4c50-8814-e32f96cef2fc",
    "EditDate": "2025-04-11T06:56:30Z",
    "CreateDate": "2025-04-11T06:56:30Z",
    "StartTime": "2025-04-11T06:56:30Z",
    "EndTime": "2025-04-11T06:56:30Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "c703c627-5f50-45e5-958d-b388bf0dffb8",
        "47128b40-6833-4b60-a065-9aaa46f28d07"
      ],
      "Companies": [
        "7302e1c8-97e2-478a-88bf-149bfd69b7e8",
        "e02d290c-5ef8-4bef-8072-adf9abe25652"
      ],
      "Groups": [
        "1cbde62c-eaa3-4e71-9ebd-b09e554ebaf3",
        "3cdbb842-6a64-4634-9987-820030b710bf"
      ],
      "Opportunities": [
        "9d45cc32-b008-43a3-b915-0c91db3bdb86",
        "24536d2a-cc77-432c-a1f9-91ccd6739fea"
      ]
    }
  }
]