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": "ab8a5c56-8633-4dd0-ac02-4e04d802691b",
    "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": "2026-02-28T22:42:33Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "bae0fb38-2bdb-43f0-ab09-40aa8e6940c4",
    "EditDate": "2026-02-28T22:42:33Z",
    "CreateDate": "2026-02-28T22:42:33Z",
    "StartTime": "2026-02-28T22:42:33Z",
    "EndTime": "2026-02-28T22:42:33Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "edf23a1c-9ecd-40ec-b399-499c11a9162c",
        "ed82f589-518f-41c2-9bba-ef4e97d8d2c1"
      ],
      "Companies": [
        "cc9b8c1b-5623-4dd5-a141-a1379f6d4ed6",
        "74b83e72-4478-4330-94eb-9c2e9d497504"
      ],
      "Groups": [
        "7835896c-9ed1-493d-ab3c-0ebc63e36b1b",
        "5b817288-93e8-4b14-8eab-c20c04996f46"
      ],
      "Opportunities": [
        "574ad982-1d98-4aaa-99bd-75078f0a7a3e",
        "9c50cd9d-f1da-458e-8170-33e93bc137d0"
      ]
    }
  },
  {
    "Id": "ab8a5c56-8633-4dd0-ac02-4e04d802691b",
    "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": "2026-02-28T22:42:33Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "bae0fb38-2bdb-43f0-ab09-40aa8e6940c4",
    "EditDate": "2026-02-28T22:42:33Z",
    "CreateDate": "2026-02-28T22:42:33Z",
    "StartTime": "2026-02-28T22:42:33Z",
    "EndTime": "2026-02-28T22:42:33Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "edf23a1c-9ecd-40ec-b399-499c11a9162c",
        "ed82f589-518f-41c2-9bba-ef4e97d8d2c1"
      ],
      "Companies": [
        "cc9b8c1b-5623-4dd5-a141-a1379f6d4ed6",
        "74b83e72-4478-4330-94eb-9c2e9d497504"
      ],
      "Groups": [
        "7835896c-9ed1-493d-ab3c-0ebc63e36b1b",
        "5b817288-93e8-4b14-8eab-c20c04996f46"
      ],
      "Opportunities": [
        "574ad982-1d98-4aaa-99bd-75078f0a7a3e",
        "9c50cd9d-f1da-458e-8170-33e93bc137d0"
      ]
    }
  }
]