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": "b42e6e5d-823f-48cc-b89e-d11be7518e11",
    "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-08-29T06:58:19Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "0c9afb7c-2b10-4308-b512-07ae31e8d56c",
    "EditDate": "2026-08-29T06:58:19Z",
    "CreateDate": "2026-08-29T06:58:19Z",
    "StartTime": "2026-08-29T06:58:19Z",
    "EndTime": "2026-08-29T06:58:19Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "1c122cd5-d69e-404b-b71d-4ee859ec2641",
        "0e619211-73d3-41dd-b7dc-7c156403a464"
      ],
      "Companies": [
        "7a87f596-e613-4585-9b94-758235941676",
        "b6439b1e-338c-4324-956b-1d6349f14596"
      ],
      "Groups": [
        "9bd1a7b2-33a3-484d-b2e8-b6bca2475d7d",
        "f53a9b4b-6121-49c9-ac85-12a20d6e72c0"
      ],
      "Opportunities": [
        "f656dc30-fd59-4460-9a89-11fe7cd311dc",
        "0db3aba1-4423-4f7a-bbe3-00fdefce6565"
      ]
    }
  },
  {
    "Id": "b42e6e5d-823f-48cc-b89e-d11be7518e11",
    "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-08-29T06:58:19Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "0c9afb7c-2b10-4308-b512-07ae31e8d56c",
    "EditDate": "2026-08-29T06:58:19Z",
    "CreateDate": "2026-08-29T06:58:19Z",
    "StartTime": "2026-08-29T06:58:19Z",
    "EndTime": "2026-08-29T06:58:19Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "1c122cd5-d69e-404b-b71d-4ee859ec2641",
        "0e619211-73d3-41dd-b7dc-7c156403a464"
      ],
      "Companies": [
        "7a87f596-e613-4585-9b94-758235941676",
        "b6439b1e-338c-4324-956b-1d6349f14596"
      ],
      "Groups": [
        "9bd1a7b2-33a3-484d-b2e8-b6bca2475d7d",
        "f53a9b4b-6121-49c9-ac85-12a20d6e72c0"
      ],
      "Opportunities": [
        "f656dc30-fd59-4460-9a89-11fe7cd311dc",
        "0db3aba1-4423-4f7a-bbe3-00fdefce6565"
      ]
    }
  }
]