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": "7fe92ce3-8c31-4e6b-b4f3-cad40a375271",
    "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-01-14T05:22:11Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "6b248459-6784-4e7d-a2f1-0edd9fc5cd8c",
    "EditDate": "2026-01-14T05:22:11Z",
    "CreateDate": "2026-01-14T05:22:11Z",
    "StartTime": "2026-01-14T05:22:11Z",
    "EndTime": "2026-01-14T05:22:11Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "9978c375-63df-41f1-b760-e60961c78c11",
        "b0f79542-41bf-4b49-bd93-af62dd9871bd"
      ],
      "Companies": [
        "e3e6dc13-bc12-46be-80fd-913e96f13998",
        "6ed76648-9dea-433a-913d-d4b806bbc231"
      ],
      "Groups": [
        "c016c109-46ec-4a60-9461-9639795a4998",
        "f9ea4623-bb9f-426f-a6b1-0a2d490586b5"
      ],
      "Opportunities": [
        "b1388174-c123-4499-b64c-a7bbee917148",
        "d6caefa2-7703-45c9-9f52-6e9d053547e5"
      ]
    }
  },
  {
    "Id": "7fe92ce3-8c31-4e6b-b4f3-cad40a375271",
    "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-01-14T05:22:11Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "6b248459-6784-4e7d-a2f1-0edd9fc5cd8c",
    "EditDate": "2026-01-14T05:22:11Z",
    "CreateDate": "2026-01-14T05:22:11Z",
    "StartTime": "2026-01-14T05:22:11Z",
    "EndTime": "2026-01-14T05:22:11Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "9978c375-63df-41f1-b760-e60961c78c11",
        "b0f79542-41bf-4b49-bd93-af62dd9871bd"
      ],
      "Companies": [
        "e3e6dc13-bc12-46be-80fd-913e96f13998",
        "6ed76648-9dea-433a-913d-d4b806bbc231"
      ],
      "Groups": [
        "c016c109-46ec-4a60-9461-9639795a4998",
        "f9ea4623-bb9f-426f-a6b1-0a2d490586b5"
      ],
      "Opportunities": [
        "b1388174-c123-4499-b64c-a7bbee917148",
        "d6caefa2-7703-45c9-9f52-6e9d053547e5"
      ]
    }
  }
]