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": "38f8c8a8-beca-4573-8c58-922b353f5ffd",
    "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-03-02T17:25:12Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "c30e7461-58ca-443b-9e29-61cea02affe5",
    "EditDate": "2026-03-02T17:25:12Z",
    "CreateDate": "2026-03-02T17:25:12Z",
    "StartTime": "2026-03-02T17:25:12Z",
    "EndTime": "2026-03-02T17:25:12Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "334bd93f-0674-4a5a-ab81-cad3e5dea311",
        "b8ceb600-41ff-4f8c-a99e-a4ddbd660057"
      ],
      "Companies": [
        "d861fa53-572e-404e-b06b-79f995785371",
        "8ab62333-f59d-4e88-a130-966badef1a40"
      ],
      "Groups": [
        "bde8ff1f-2f1f-4498-b76d-e2480a0bc759",
        "0365fba4-2c9e-4cd0-a88f-581e263a7b96"
      ],
      "Opportunities": [
        "814fb520-922c-46b6-80b8-385cbfaa29aa",
        "3f5f84b2-ab47-420c-b48b-871e253521f7"
      ]
    }
  },
  {
    "Id": "38f8c8a8-beca-4573-8c58-922b353f5ffd",
    "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-03-02T17:25:12Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "c30e7461-58ca-443b-9e29-61cea02affe5",
    "EditDate": "2026-03-02T17:25:12Z",
    "CreateDate": "2026-03-02T17:25:12Z",
    "StartTime": "2026-03-02T17:25:12Z",
    "EndTime": "2026-03-02T17:25:12Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "334bd93f-0674-4a5a-ab81-cad3e5dea311",
        "b8ceb600-41ff-4f8c-a99e-a4ddbd660057"
      ],
      "Companies": [
        "d861fa53-572e-404e-b06b-79f995785371",
        "8ab62333-f59d-4e88-a130-966badef1a40"
      ],
      "Groups": [
        "bde8ff1f-2f1f-4498-b76d-e2480a0bc759",
        "0365fba4-2c9e-4cd0-a88f-581e263a7b96"
      ],
      "Opportunities": [
        "814fb520-922c-46b6-80b8-385cbfaa29aa",
        "3f5f84b2-ab47-420c-b48b-871e253521f7"
      ]
    }
  }
]